Skip to content

Commit

Permalink
[loki] Moves grpc keep-alive option to a separate chunk
Browse files Browse the repository at this point in the history
  • Loading branch information
eldarnash committed Jan 25, 2024
1 parent aedcc64 commit 160f001
Showing 2 changed files with 35 additions and 30 deletions.
31 changes: 1 addition & 30 deletions content/chapter-destinations/destination-loki/_index.md
Original file line number Diff line number Diff line change
@@ -43,36 +43,7 @@ The `loki()` destination has the following options.

{{% include-headless "chunk/option-destination-batch-timeout.md" %}}

## keep-alive()

Configures how {{% param "product.abbrev" %}} sends [gRPC keepalive pings](https://grpc.io/docs/guides/keepalive/).

### max-pings-without-data()

| | |
| -------- | ------------------ |
| Type: | integer |
| Default: | |

*Description:* The maximum number of gRPC pings that can be sent when there is no data/header frame to be sent. {{% param "product.abbrev" %}} won't send any pings after this limit. Set it to 0 disable this restriction and keep sending pings.

### time()

| | |
| -------- | ------------------ |
| Type: | number [milliseconds] |
| Default: | |

*Description:* The period (in milliseconds) after which {{% param "product.abbrev" %}} sends a gRPC keepalive ping.

### timeout()

| | |
| -------- | ------------------ |
| Type: | number [milliseconds] |
| Default: | 10 |

*Description:* The time (in milliseconds) {{% param "product.abbrev" %}} waits for an acknowledgement.
{{< include-headless "chunk/option-destination-grpc-keep-alive.md" >}}

## labels()

34 changes: 34 additions & 0 deletions content/headless/chunk/option-destination-grpc-keep-alive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
---
<!-- This file is under the copyright of Axoflow, and licensed under Apache License 2.0, except for using the Axoflow and AxoSyslog trademarks. -->

## keep-alive()

Configures how {{% param "product.abbrev" %}} sends [gRPC keepalive pings](https://grpc.io/docs/guides/keepalive/).

### max-pings-without-data()

| | |
| -------- | ------------------ |
| Type: | integer |
| Default: | |

*Description:* The maximum number of gRPC pings that can be sent when there is no data/header frame to be sent. {{% param "product.abbrev" %}} won't send any pings after this limit. Set it to 0 disable this restriction and keep sending pings.

### time()

| | |
| -------- | ------------------ |
| Type: | number [milliseconds] |
| Default: | |

*Description:* The period (in milliseconds) after which {{% param "product.abbrev" %}} sends a gRPC keepalive ping.

### timeout()

| | |
| -------- | ------------------ |
| Type: | number [milliseconds] |
| Default: | 10 |

*Description:* The time (in milliseconds) {{% param "product.abbrev" %}} waits for an acknowledgement.

0 comments on commit 160f001

Please sign in to comment.