Skip to content

Commit 62f500e

Browse files
author
thang
committed
correct docs typos
1 parent 403873f commit 62f500e

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,10 @@ CORRELATION_ID_HEADERS | List of HTTP headers that will be used to look for corr
127127
EMPTY_VALUE | Default value when a logging record property is None | '-'
128128
CORRELATION_ID_GENERATOR | function to generate unique correlation-id | uuid.uuid1
129129
JSON_SERIALIZER | function to encode object to JSON | json.dumps
130-
COMPONENT_ID | Uniquely identifies the software component that has processed the current
131-
request | EMPTY_VALUE
130+
COMPONENT_ID | Uniquely identifies the software component that has processed the current request | EMPTY_VALUE
132131
COMPONENT_NAME | A human-friendly name representing the software component | EMPTY_VALUE
133132
COMPONENT_INSTANCE_INDEX | Instance's index of horizontally scaled service | 0
134-
CREATE_CORRELATION_ID_IF_NOT_EXISTS | Whether to generate an new correlation-id in case one is not present| True
133+
CREATE_CORRELATION_ID_IF_NOT_EXISTS | Whether to generate a new correlation-id in case one is not present| True
135134

136135
# 4. Python References
137136

@@ -170,7 +169,8 @@ pip3 install .
170169
```
171170
# 7. References
172171
## [0] Full logging format references
173-
- Common field
172+
- Common field
173+
174174
Field | Description | Format | Example
175175
--- | --- | --- | ---
176176
written_at | The date when this log message was written. | ISO 8601 YYYY-MM-DDTHH:MM:SS.milliZ | 2017-12-23T15:14:02.208Z
@@ -182,7 +182,8 @@ request | string | 9e6f3ecf-def0-4baf-8fac-9339e61d5645
182182
component_name | A human-friendly name representing the software component | string | my-fancy-component
183183
component_instance | Instance's index of horizontally scaled service | string | 0
184184

185-
- application logs: https://github.com/SAP/cf-java-logging-support/blob/master/cf-java-logging-support-core/beats/app-logs/docs/fields.asciidoc#exported-fields-app-logs
185+
- application logs
186+
186187
Field | Description | Format | Example
187188
--- | --- | --- | ---
188189
msg | The actual message string passed to the logger. | string | This is a log message
@@ -192,19 +193,20 @@ logger | The logger name that emits the log message.
192193
| string | requests-logger
193194

194195
- request logs:
196+
195197
Field | Description | Format | Example
196198
--- | --- | --- | ---
197-
request | request path that has been processed. | string | /get/api/v2
199+
request | request path that has been processed. | string | /get/api/v2
198200
request_received_at | The date when an incoming request was received by the producer.| ISO 8601 YYYY-MM-DDTHH:MM:SS.milliZ The precision is in milliseconds. The timezone is UTC. | 2015-01-24 14:06:05.071Z
199201
response_sent_at | The date when the response to an incoming request was sent to the consumer. | ditto | 2015-01-24 14:06:05.071Z
200202
response_time_ms | How many milliseconds it took the producer to prepare the response. | float | 43.476
201-
protocol | Which protocol was used to issue a request to a producer. In most cases, this will be HTTP (including a version specifier), but for outgoing requests reported by a producer it may contain other values. E.g. a database call via JDBC may report, e.g. "JDBC/1.2" | string | HTTP/1.1
203+
protocol | Which protocol was used to issue a request to a producer. In most cases, this will be HTTP (including a version specifier), but for outgoing requests reported by a producer, it may contain other values. E.g. a database call via JDBC may report, e.g. "JDBC/1.2" | string | HTTP/1.1
202204
method | The corresponding protocol method. | string | GET
203205
remote_ip | IP address of the consumer (might be a proxy, might be the actual client) | string | 192.168.0.1
204206
remote_host | host name of the consumer (might be a proxy, might be the actual client) | string | my.happy.host
205207
remote_port | Which TCP port is used by the consumer to establish a connection to the remote producer. | string | 1234
206208
remote_user | The username associated with the request | string | user_name
207-
request_size_b | The size in bytes of the request entity or "body" (e.g., in case of POST requests). | long | 1234
209+
request_size_b | The size in bytes of the requesting entity or "body" (e.g., in case of POST requests). | long | 1234
208210
response_status | The status code of the response. | long | 200
209211
response_content_type | The MIME type associated with the entity of the response if available/specified | long | application/json
210212
referer | For HTTP requests, identifies the address of the webpage (i.e. the URI or IRI) that linked to the resource being requested. | string | /index.html

0 commit comments

Comments
 (0)