Skip to content

Conversation

@florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Sep 10, 2025

Fixes DOC-14144 DOC-14437 DOC-14537 DOC-8496 DOC-14810

  • In configure-logs.md, (a) added sections for Output to OTLP-compatible network collectors and Set OTLP defaults (b) updated default log config.
  • In logging-use-cases.md, modified example for Network logging with log buffering to use OTLP instead of Fluentd.

Rendered preview

…twork collectors and Set OTLP.

In logging-use-cases.md, modified example for Network logging with log buffering to use OTLP instead of Fluentd.
@github-actions
Copy link

@netlify
Copy link

netlify bot commented Sep 10, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit caddb58
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/68c976121f0b3200085def65

@netlify
Copy link

netlify bot commented Sep 10, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit caddb58
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/68c9761232c73c0008726ffc

@florence-crl
Copy link
Contributor Author

Hi @arjunmahishi, I assigned you to do this docs review since you reviewed Mudit Somani’s code prs. tia

@netlify
Copy link

netlify bot commented Sep 10, 2025

Netlify Preview

Name Link
🔨 Latest commit caddb58
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/68c9761227d15a0008fcdc57
😎 Deploy Preview https://deploy-preview-20320--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

@arjunmahishi arjunmahishi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @florence-crl!
I've left one suggestion. Rest looks good to me.

Copy link

@arjunmahishi arjunmahishi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, all comments non-blocking take or leave

| `mode` | Protocol used to export logs. Valid values `grpc` or `http`.<br><br>**Default:**`grpc` |
| `headers` | Map of key-value string pairs which will be appended to every request as custom gRPC or HTTP headers depending on the `mode` selected. For example, `"x-api-key": "YOUR_API_KEY_HERE"`. |
| `compression` | Compression for requests. Valid values `gzip` or `none`.<br><br>**Default:**`gzip` |
| `buffering` | Configures buffering of log messages for the sink, with the following sub-parameters:<ul><li>`max-staleness`: The maximum time a log message will wait in the buffer before a flush is triggered. Set to `0` to disable flushing based on elapsed time. Default: `5s`</li><li>`flush-trigger-size`: The number of bytes that will trigger the buffer to flush. Set to `0` to disable flushing based on accumulated size. Default: `1MiB`</li><li>`max-buffer-size`: The maximum size of the buffer: new log messages received when the buffer is full cause older messages to be dropped. Default: `50MiB`</li></ul>When `max-staleness` and `flush-trigger-size` are used together, whichever is reached first will trigger the flush. `buffering` is enabled by default for OTLP log sinks. To explicitly disable log buffering, specify `buffering: NONE` instead. This setting is typically disabled for [security-related logs]({% link {{ page.version.version }}/logging-use-cases.md %}#security-and-audit-monitoring). See [Log buffering](#log-buffering-for-network-sinks) for more details and usage.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest either bolding these uses of "Default: foo" or unbolding the prior ones in the table

Copy link
Contributor Author

@florence-crl florence-crl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TFTRs!

@florence-crl florence-crl merged commit d9ab57b into main Sep 16, 2025
5 checks passed
@florence-crl florence-crl deleted the DOC-14144 branch September 16, 2025 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants