Skip to content

Commit fbcf137

Browse files
florence-crlflorence-crl
committed
In configure-logs.md, added link to OTLP server registry and updated default log config.
1 parent b5b0496 commit fbcf137

File tree

1 file changed

+191
-20
lines changed

1 file changed

+191
-20
lines changed

‎src/current/v25.4/configure-logs.md

Lines changed: 191 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,9 @@ For an example network logging configuration, see [Logging use cases]({% link {{
279279
280280
### Output to OTLP-compatible network collectors
281281
282-
CockroachDB can send logs to an [OpenTelemetry](https://opentelemetry.io/)-compatible server using the OTLP protocol. Define `otlp-servers` to select channels and configure connection and protocol details. For example:
282+
CockroachDB can send logs to an [OpenTelemetry](https://opentelemetry.io/)-compatible server using the OTLP protocol (e.g., [Datadog agent](https://docs.datadoghq.com/agent/?tab=Host-based)). For a complete list of log servers that support the OTLP protocol, see the [OpenTelemetry registry](https://opentelemetry.io/ecosystem/vendors/).
283+
284+
Define `otlp-servers` to select channels and configure connection and protocol details. For example:
283285
284286
~~~ yaml
285287
file-defaults: ...
@@ -754,73 +756,242 @@ The YAML payload below represents the default logging behavior of [`cockroach st
754756
755757
~~~ yaml
756758
file-defaults:
759+
dir: /cockroach-data/logs
757760
max-file-size: 10MiB
758761
max-group-size: 100MiB
759-
file-permissions: 644
762+
file-permissions: "0640"
760763
buffered-writes: true
761764
filter: INFO
762765
format: crdb-v2
763766
redact: false
764767
redactable: true
765768
exit-on-error: true
766769
auditable: false
770+
buffering: NONE
767771
fluent-defaults:
768772
filter: INFO
769773
format: json-fluent-compact
770774
redact: false
771775
redactable: true
772776
exit-on-error: false
773777
auditable: false
778+
buffering:
779+
max-staleness: 5s
780+
flush-trigger-size: 1.0MiB
781+
max-buffer-size: 50MiB
782+
format: newline
774783
http-defaults:
775784
method: POST
776785
unsafe-tls: false
777-
timeout: 0s
786+
timeout: 2s
778787
disable-keep-alives: false
788+
compression: gzip
779789
filter: INFO
780790
format: json-compact
781791
redact: false
782792
redactable: true
783793
exit-on-error: false
784794
auditable: false
795+
buffering:
796+
max-staleness: 5s
797+
flush-trigger-size: 1.0MiB
798+
max-buffer-size: 50MiB
799+
format: newline
800+
otlp-defaults:
801+
mode: grpc
802+
compression: gzip
803+
filter: INFO
804+
format: json
805+
redact: false
806+
redactable: true
807+
exit-on-error: false
808+
auditable: false
809+
buffering:
810+
max-staleness: 5s
811+
flush-trigger-size: 1.0MiB
812+
max-buffer-size: 50MiB
813+
format: newline
785814
sinks:
786815
file-groups:
816+
changefeed:
817+
channels: {INFO: [CHANGEFEED]}
818+
dir: /cockroach-data/logs
819+
max-file-size: 10MiB
820+
max-group-size: 100MiB
821+
file-permissions: "0640"
822+
buffered-writes: true
823+
filter: INFO
824+
format: crdb-v2
825+
redact: false
826+
redactable: true
827+
exit-on-error: true
828+
buffering: NONE
787829
default:
788-
channels:
789-
INFO: [DEV, OPS]
790-
WARNING: all except [DEV, OPS]
830+
channels: {INFO: [DEV, OPS], WARNING: [HEALTH, STORAGE, SESSIONS, SQL_SCHEMA, USER_ADMIN, PRIVILEGES, SENSITIVE_ACCESS, SQL_EXEC, SQL_PERF, SQL_INTERNAL_PERF, TELEMETRY, KV_DISTRIBUTION, CHANGEFEED, KV_EXEC]}
831+
dir: /cockroach-data/logs
832+
max-file-size: 10MiB
833+
max-group-size: 100MiB
834+
file-permissions: "0640"
835+
buffered-writes: true
836+
filter: INFO
837+
format: crdb-v2
838+
redact: false
839+
redactable: true
840+
exit-on-error: true
841+
buffering: NONE
791842
health:
792-
channels: [HEALTH]
843+
channels: {INFO: [HEALTH]}
844+
dir: /cockroach-data/logs
845+
max-file-size: 10MiB
846+
max-group-size: 100MiB
847+
file-permissions: "0640"
848+
buffered-writes: true
849+
filter: INFO
850+
format: crdb-v2
851+
redact: false
852+
redactable: true
853+
exit-on-error: true
854+
buffering: NONE
793855
kv-distribution:
794-
channels: [KV_DISTRIBUTION]
856+
channels: {INFO: [KV_DISTRIBUTION]}
857+
dir: /cockroach-data/logs
858+
max-file-size: 10MiB
859+
max-group-size: 100MiB
860+
file-permissions: "0640"
861+
buffered-writes: true
862+
filter: INFO
863+
format: crdb-v2
864+
redact: false
865+
redactable: true
866+
exit-on-error: true
867+
buffering: NONE
795868
pebble:
796-
channels: [STORAGE]
869+
channels: {INFO: [STORAGE]}
870+
dir: /cockroach-data/logs
871+
max-file-size: 10MiB
872+
max-group-size: 100MiB
873+
file-permissions: "0640"
874+
buffered-writes: true
875+
filter: INFO
876+
format: crdb-v2
877+
redact: false
878+
redactable: true
879+
exit-on-error: true
880+
buffering: NONE
797881
security:
798-
channels: [PRIVILEGES, USER_ADMIN]
799-
auditable: true
882+
channels: {INFO: [USER_ADMIN, PRIVILEGES]}
883+
dir: /cockroach-data/logs
884+
max-file-size: 10MiB
885+
max-group-size: 100MiB
886+
file-permissions: "0640"
887+
buffered-writes: false
888+
filter: INFO
889+
format: crdb-v2
890+
redact: false
891+
redactable: true
892+
exit-on-error: true
893+
buffering: NONE
800894
sql-audit:
801-
channels: [SENSITIVE_ACCESS]
802-
auditable: true
895+
channels: {INFO: [SENSITIVE_ACCESS]}
896+
dir: /cockroach-data/logs
897+
max-file-size: 10MiB
898+
max-group-size: 100MiB
899+
file-permissions: "0640"
900+
buffered-writes: false
901+
filter: INFO
902+
format: crdb-v2
903+
redact: false
904+
redactable: true
905+
exit-on-error: true
906+
buffering: NONE
803907
sql-auth:
804-
channels: [SESSIONS]
805-
auditable: true
908+
channels: {INFO: [SESSIONS]}
909+
dir: /cockroach-data/logs
910+
max-file-size: 10MiB
911+
max-group-size: 100MiB
912+
file-permissions: "0640"
913+
buffered-writes: false
914+
filter: INFO
915+
format: crdb-v2
916+
redact: false
917+
redactable: true
918+
exit-on-error: true
919+
buffering: NONE
806920
sql-exec:
807-
channels: [SQL_EXEC]
921+
channels: {INFO: [SQL_EXEC]}
922+
dir: /cockroach-data/logs
923+
max-file-size: 10MiB
924+
max-group-size: 100MiB
925+
file-permissions: "0640"
926+
buffered-writes: true
927+
filter: INFO
928+
format: crdb-v2
929+
redact: false
930+
redactable: true
931+
exit-on-error: true
932+
buffering: NONE
933+
sql-schema:
934+
channels: {INFO: [SQL_SCHEMA]}
935+
dir: /cockroach-data/logs
936+
max-file-size: 10MiB
937+
max-group-size: 100MiB
938+
file-permissions: "0640"
939+
buffered-writes: true
940+
filter: INFO
941+
format: crdb-v2
942+
redact: false
943+
redactable: true
944+
exit-on-error: true
945+
buffering: NONE
808946
sql-slow:
809-
channels: [SQL_PERF]
947+
channels: {INFO: [SQL_PERF]}
948+
dir: /cockroach-data/logs
949+
max-file-size: 10MiB
950+
max-group-size: 100MiB
951+
file-permissions: "0640"
952+
buffered-writes: true
953+
filter: INFO
954+
format: crdb-v2
955+
redact: false
956+
redactable: true
957+
exit-on-error: true
958+
buffering: NONE
810959
sql-slow-internal-only:
811-
channels: [SQL_INTERNAL_PERF]
960+
channels: {INFO: [SQL_INTERNAL_PERF]}
961+
dir: /cockroach-data/logs
962+
max-file-size: 10MiB
963+
max-group-size: 100MiB
964+
file-permissions: "0640"
965+
buffered-writes: true
966+
filter: INFO
967+
format: crdb-v2
968+
redact: false
969+
redactable: true
970+
exit-on-error: true
971+
buffering: NONE
812972
telemetry:
813-
channels: [TELEMETRY]
973+
channels: {INFO: [TELEMETRY]}
974+
dir: /cockroach-data/logs
814975
max-file-size: 100KiB
815976
max-group-size: 1.0MiB
977+
file-permissions: "0640"
978+
buffered-writes: true
979+
filter: INFO
980+
format: crdb-v2
981+
redact: false
982+
redactable: true
983+
exit-on-error: true
984+
buffering: NONE
816985
stderr:
817-
channels: all
818986
filter: NONE
987+
format: crdb-v2-tty
819988
redact: false
820989
redactable: true
821990
exit-on-error: true
991+
buffering: NONE
822992
capture-stray-errors:
823993
enable: true
994+
dir: /cockroach-data/logs
824995
max-group-size: 100MiB
825996
~~~
826997

0 commit comments

Comments
 (0)