From 2a52cf08465cc03704b0d2e32d6e62f62a6bef26 Mon Sep 17 00:00:00 2001 From: Warren Fernandes Date: Mon, 13 Nov 2017 21:12:33 -0700 Subject: [PATCH 1/2] Fixes readme anchor links --- events/README.md | 46 +++++++++++++++++++--------------------------- 1 file changed, 19 insertions(+), 27 deletions(-) diff --git a/events/README.md b/events/README.md index 20d7430..4d09ea2 100644 --- a/events/README.md +++ b/events/README.md @@ -29,9 +29,8 @@ ## envelope.proto - - ### Envelope + Envelope wraps an Event and adds metadata. | Field | Type | Label | Description | @@ -52,9 +51,8 @@ Envelope wraps an Event and adds metadata. | containerMetric | [ContainerMetric](#events.ContainerMetric) | optional | | - ### Envelope.TagsEntry - + | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | @@ -63,8 +61,8 @@ Envelope wraps an Event and adds metadata. - ### Envelope.EventType + Type of the wrapped event. | Name | Number | Description | @@ -77,17 +75,15 @@ Type of the wrapped event. | ContainerMetric | 9 | | - - -

Top

## error.proto + - ### Error + An Error event represents an error in the originating process. | Field | Type | Label | Description | @@ -97,19 +93,15 @@ An Error event represents an error in the originating process. | message | [string](#string) | required | Error description (preferably human-readable). | - - - - -

Top

## http.proto + - ### HttpStartStop + An HttpStartStop event represents the whole lifecycle of an HTTP request. | Field | Type | Label | Description | @@ -131,8 +123,8 @@ An HttpStartStop event represents the whole lifecycle of an HTTP request. - ### Method + HTTP method. | Name | Number | Description | @@ -182,8 +174,8 @@ HTTP method. | UPDATEREDIRECTREF | 43 | | | VERSION_CONTROL | 44 | | - ### PeerType + Type of peer handling request. | Name | Number | Description | @@ -194,15 +186,15 @@ Type of peer handling request. -

Top

## log.proto + - ### LogMessage + A LogMessage contains a "log line" and associated metadata. | Field | Type | Label | Description | @@ -216,8 +208,8 @@ A LogMessage contains a "log line" and associated metadata. - ### LogMessage.MessageType + MessageType stores the destination of the message (corresponding to STDOUT or STDERR). | Name | Number | Description | @@ -228,15 +220,15 @@ MessageType stores the destination of the message (corresponding to STDOUT or ST -

Top

## metric.proto + - ### ContainerMetric + A ContainerMetric records resource usage of an app in a container. | Field | Type | Label | Description | @@ -250,8 +242,8 @@ A ContainerMetric records resource usage of an app in a container. | diskBytesQuota | [uint64](#uint64) | optional | Maximum bytes of disk allocated to container. | - ### CounterEvent + A CounterEvent represents the increment of a counter. It contains only the change in the value; it is the responsibility of downstream consumers to maintain the value of the counter. | Field | Type | Label | Description | @@ -261,8 +253,8 @@ A CounterEvent represents the increment of a counter. It contains only the chang | total | [uint64](#uint64) | optional | Total value of the counter. This will be overridden by Metron, which internally tracks the total of each named Counter it receives. | - ### ValueMetric + A ValueMetric indicates the value of a metric at an instant in time. | Field | Type | Label | Description | @@ -276,15 +268,15 @@ A ValueMetric indicates the value of a metric at an instant in time. -

Top

## uuid.proto + - ### UUID + Type representing a 128-bit UUID. The bytes of the UUID should be packed in little-endian **byte** (not bit) order. For example, the UUID `f47ac10b-58cc-4372-a567-0e02b2c3d479` should be encoded as `UUID{ low: 0x7243cc580bc17af4, high: 0x79d4c3b2020e67a5 }` @@ -300,8 +292,8 @@ The bytes of the UUID should be packed in little-endian **byte** (not bit) order - ## Scalar Value Types + | .proto Type | Notes | C++ Type | Java Type | Python Type | | ----------- | ----- | -------- | --------- | ----------- | From b30089c0c79022c164c318bcbcb2a5787092ae54 Mon Sep 17 00:00:00 2001 From: Warren Fernandes Date: Mon, 13 Nov 2017 21:14:51 -0700 Subject: [PATCH 2/2] Adds top link to the bottom of the README --- events/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/events/README.md b/events/README.md index 4d09ea2..1c3d511 100644 --- a/events/README.md +++ b/events/README.md @@ -312,3 +312,5 @@ The bytes of the UUID should be packed in little-endian **byte** (not bit) order | bool | | bool | boolean | boolean | | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | + +

Top