Skip to content

Commit 0ba26ee

Browse files
committed
adding sitemap
1 parent 80649cd commit 0ba26ee

File tree

3 files changed

+347
-13
lines changed

3 files changed

+347
-13
lines changed

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3 class="title">LogMetrics Framework</h3>
117117
</div><!--//icon-holder-->
118118
<h3 class="title">Obfuscator Framework</h3>
119119
<p class="intro">Obfuscator Frameworks for Spring Java Projects & Python Projects</p>
120-
<a class="link" href="#"><span></span></a>
120+
<a class="link" href="obfuscator.html"><span></span></a>
121121
</div><!--//item-inner-->
122122
</div><!--//item-->
123123
<div class="item item-blue col-lg-4 col-6">

logmetrics.html

Lines changed: 74 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ <h1 class="logo">
5858
</div><!--//branding-->
5959
<ol class="breadcrumb">
6060
<li class="breadcrumb-item"><a href="index.html">Home</a></li>
61-
<li class="breadcrumb-item active">LogMetrics</li>
61+
<li class="breadcrumb-item active">LogMetrics Framework</li>
6262
</ol>
6363
</div><!--//container-->
6464
</header><!--//header-->
@@ -74,28 +74,27 @@ <h1 class="doc-title"><i class="icon_datareport_alt"></i> LogMetrics Framework</
7474
<section id="download-section" class="doc-section">
7575
<h2 class="section-title">General</h2>
7676
<div class="section-block">
77-
<p>LogMetrics framework provides simplified configuration to log payload for spring java projects & python projects
77+
<p>LogMetrics Framework is used to collect and log the API metrics data and capture
78+
the request and response payload.
7879
</p>
7980
</div>
8081
</section><!--//doc-section-->
8182
<section id="code-section" class="doc-section">
8283
<h2 class="section-title">Java</h2>
8384
<div class="section-block">
84-
<p>LogMetrics framework provides simplified configuration to log payload for spring java projects</p>
85-
<div class="github-btn mb-2">
86-
<a class="github-button" href="https://github.com/devxchangeio/logmetrics-java" target="_blank">GitHub</a>
87-
</div>
85+
<p>LogMetrics provides simplified configuration to log payload for
86+
spring java projects</p>
8887
</div><!--//section-block-->
8988
<div id="repo" class="section-block">
9089
<div class="code-block">
9190
<h6>Repository</h6>
92-
<pre><code class="language-javascript"> maven { url "https://devxchange.bintray.com/maven-repo/"}</code></pre>
91+
<pre><code class="language-javascript"> maven { url "https://dl.bintray.com/m2/release"}</code></pre>
9392
</div><!--//code-block-->
9493
</div><!--//section-block-->
9594
<div id="dependency" class="section-block">
9695
<div class="code-block">
9796
<h6>Dependency- Gradle</h6>
98-
<pre><code class="language-javascript">compile group: 'io.devxchange', name: 'logmetrics', version: '1.0.0-SNAPSHOT'</code></pre>
97+
<pre><code class="language-javascript">compile ("io.devxchange:logmetrics:0.0.2")</code></pre>
9998
</div><!--//code-block-->
10099
</div><!--//section-block-->
101100
<div id="properties" class="section-block">
@@ -104,7 +103,10 @@ <h6>properties</h6>
104103
<pre><code class="language-css">logmetrics.logging.enabled=true
105104
logmetrics.logging.request.enabled=true
106105
logmetrics.logging.response.enabled=true
107-
</code></pre>
106+
logmetrics.logging.obfuscate.enabled=false
107+
logmetrics.logging.obfuscate.md5.fields= #comma seperated fields
108+
logmetrics.logging.obfuscate.sha256.fields= #comma seperated fields
109+
logmetrics.logging.obfuscate.fields= #comma seperated fields</code></pre>
108110
</div><!--//code-block-->
109111
</div><!--//section-block-->
110112
<div id="appconfig" class="section-block">
@@ -140,12 +142,71 @@ <h6>SpringApplication</h6>
140142
</code></pre>
141143
</div><!--//code-block-->
142144
</div><!--//section-block-->
145+
<div id="schema" class="section-block">
146+
<div class="code-block">
147+
<h6>Logmetrics Schema</h6>
148+
<pre><code class="language-javascript">
149+
{
150+
"$schema": "http://json-schema.org/draft-04/schema#",
151+
"type": "LogMetrics",
152+
"properties": {
153+
"Node": {
154+
"type": "string",
155+
"description": "Application Host IP Address"
156+
},
157+
"message_type": {
158+
"type": "string",
159+
"description": "Logmetrics message type",
160+
"value": "LOGMETRICS_MESSAGE"
161+
},
162+
"Duration": {
163+
"type": "integer",
164+
"description": "Response time of the API"
165+
},
166+
"Host": {
167+
"type": "string",
168+
"description": "Application Host Name"
169+
},
170+
"Fault": {
171+
"type": "boolean",
172+
"description": "API Success or Failed status "
173+
},
174+
"Method": {
175+
"type": "string",
176+
"description": "API Method name"
177+
},
178+
"ResponseBody": {
179+
"type": "string",
180+
"description": "API Response Body"
181+
},
182+
"StartDateTime": {
183+
"type": "string",
184+
"description": "API Start Time"
185+
},
186+
"EndDateTime": {
187+
"type": "string",
188+
"description": "API End time"
189+
},
190+
"HttpMethod": {
191+
"type": "string",
192+
"description": "Http Method Type"
193+
},
194+
"RequestBody": {
195+
"type": "string",
196+
"description": "API Request Body"
197+
}
198+
}
199+
}</code></pre></div><!--//code-block-->
200+
</div><!--//section-block-->
143201
<div id="release" class="section-block">
144202
<div class="code-block">
145203
<h6>Release</h6>
146-
<h7>1.0.0-SNAPSHOT</h7>
147-
<pre><code class="language-handlebars">* logging rest verb & payload to console.
148-
* feature to enable/disable payload logging
204+
<h7>0.0.2</h7>
205+
<pre><code class="language-handlebars">adding request and response payload obfuscation (masking sensitive information)
206+
</code></pre>
207+
<h7>0.0.1</h7>
208+
<pre><code class="language-handlebars">logging rest verb & payload to console.
209+
feature to enable/disable payload logging
149210
</code></pre>
150211
</div><!--//code-block-->
151212
</div><!--//section-block-->
@@ -171,6 +232,7 @@ <h6>Git Demo Example</h6>
171232
<a class="nav-link scrollto" href="#dependency">Dependency</a>
172233
<a class="nav-link scrollto" href="#properties">Properties</a>
173234
<a class="nav-link scrollto" href="#appconfig">AppConfig</a>
235+
<a class="nav-link scrollto" href="#schema">LogMetrics Schema</a>
174236
<a class="nav-link scrollto" href="#release">Release</a>
175237
<a class="nav-link scrollto" href="#demo">Demo</a>
176238
</nav><!--//nav-->

0 commit comments

Comments
 (0)