@@ -58,7 +58,7 @@ <h1 class="logo">
58
58
</ div > <!--//branding-->
59
59
< ol class ="breadcrumb ">
60
60
< 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 >
62
62
</ ol >
63
63
</ div > <!--//container-->
64
64
</ header > <!--//header-->
@@ -74,28 +74,27 @@ <h1 class="doc-title"><i class="icon_datareport_alt"></i> LogMetrics Framework</
74
74
< section id ="download-section " class ="doc-section ">
75
75
< h2 class ="section-title "> General</ h2 >
76
76
< 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.
78
79
</ p >
79
80
</ div >
80
81
</ section > <!--//doc-section-->
81
82
< section id ="code-section " class ="doc-section ">
82
83
< h2 class ="section-title "> Java</ h2 >
83
84
< 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 >
88
87
</ div > <!--//section-block-->
89
88
< div id ="repo " class ="section-block ">
90
89
< div class ="code-block ">
91
90
< 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 >
93
92
</ div > <!--//code-block-->
94
93
</ div > <!--//section-block-->
95
94
< div id ="dependency " class ="section-block ">
96
95
< div class ="code-block ">
97
96
< 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 >
99
98
</ div > <!--//code-block-->
100
99
</ div > <!--//section-block-->
101
100
< div id ="properties " class ="section-block ">
@@ -104,7 +103,10 @@ <h6>properties</h6>
104
103
< pre > < code class ="language-css "> logmetrics.logging.enabled=true
105
104
logmetrics.logging.request.enabled=true
106
105
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 >
108
110
</ div > <!--//code-block-->
109
111
</ div > <!--//section-block-->
110
112
< div id ="appconfig " class ="section-block ">
@@ -140,12 +142,71 @@ <h6>SpringApplication</h6>
140
142
</ code > </ pre >
141
143
</ div > <!--//code-block-->
142
144
</ 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-->
143
201
< div id ="release " class ="section-block ">
144
202
< div class ="code-block ">
145
203
< 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
149
210
</ code > </ pre >
150
211
</ div > <!--//code-block-->
151
212
</ div > <!--//section-block-->
@@ -171,6 +232,7 @@ <h6>Git Demo Example</h6>
171
232
< a class ="nav-link scrollto " href ="#dependency "> Dependency</ a >
172
233
< a class ="nav-link scrollto " href ="#properties "> Properties</ a >
173
234
< a class ="nav-link scrollto " href ="#appconfig "> AppConfig</ a >
235
+ < a class ="nav-link scrollto " href ="#schema "> LogMetrics Schema</ a >
174
236
< a class ="nav-link scrollto " href ="#release "> Release</ a >
175
237
< a class ="nav-link scrollto " href ="#demo "> Demo</ a >
176
238
</ nav > <!--//nav-->
0 commit comments