Skip to content

Commit c8014d6

Browse files
jack-bergjack-berg
authored
Add _file suffix to OTLP exporter certificate properties (#166)
1 parent fcc86b4 commit c8014d6

File tree

6 files changed

+103
-103
lines changed

6 files changed

+103
-103
lines changed

‎examples/kitchen-sink.yaml‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,18 @@ logger_provider:
4848
# Configure exporter to be OTLP with HTTP transport.
4949
otlp_http:
5050
endpoint: http://localhost:4318/v1/logs
51-
# Configure certificate.
52-
# Absolute path to certificate file.
51+
# Configure certificate used to verify a server's TLS credentials.
52+
# Absolute path to certificate file in PEM format.
5353
# If omitted or null, system default certificate verification is used for secure connections.
54-
certificate: /app/cert.pem
54+
certificate_file: /app/cert.pem
5555
# Configure mTLS private client key.
56-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
56+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
5757
# If omitted or null, mTLS is not used.
58-
client_key: /app/cert.pem
58+
client_key_file: /app/cert.pem
5959
# Configure mTLS client certificate.
60-
# Absolute path to certificate file. If set, .client_key must also be set.
60+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
6161
# If omitted or null, mTLS is not used.
62-
client_certificate: /app/cert.pem
62+
client_certificate_file: /app/cert.pem
6363
# Configure headers. Entries have higher priority than entries from .headers_list.
6464
# If an entry's .value is null, the entry is ignored.
6565
headers:
@@ -90,18 +90,18 @@ logger_provider:
9090
# Configure endpoint.
9191
# If omitted or null, http://localhost:4317 is used.
9292
endpoint: http://localhost:4317
93-
# Configure certificate.
94-
# Absolute path to certificate file.
93+
# Configure certificate used to verify a server's TLS credentials.
94+
# Absolute path to certificate file in PEM format.
9595
# If omitted or null, system default certificate verification is used for secure connections.
96-
certificate: /app/cert.pem
96+
certificate_file: /app/cert.pem
9797
# Configure mTLS private client key.
98-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
98+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
9999
# If omitted or null, mTLS is not used.
100-
client_key: /app/cert.pem
100+
client_key_file: /app/cert.pem
101101
# Configure mTLS client certificate.
102-
# Absolute path to certificate file. If set, .client_key must also be set.
102+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
103103
# If omitted or null, mTLS is not used.
104-
client_certificate: /app/cert.pem
104+
client_certificate_file: /app/cert.pem
105105
# Configure headers. Entries have higher priority than entries from .headers_list.
106106
# If an entry's .value is null, the entry is ignored.
107107
headers:
@@ -222,18 +222,18 @@ meter_provider:
222222
# Configure endpoint, including the metric specific path.
223223
# If omitted or null, http://localhost:4318/v1/metrics is used.
224224
endpoint: http://localhost:4318/v1/metrics
225-
# Configure certificate.
226-
# Absolute path to certificate file.
225+
# Configure certificate used to verify a server's TLS credentials.
226+
# Absolute path to certificate file in PEM format.
227227
# If omitted or null, system default certificate verification is used for secure connections.
228-
certificate: /app/cert.pem
228+
certificate_file: /app/cert.pem
229229
# Configure mTLS private client key.
230-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
230+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
231231
# If omitted or null, mTLS is not used.
232-
client_key: /app/cert.pem
232+
client_key_file: /app/cert.pem
233233
# Configure mTLS client certificate.
234-
# Absolute path to certificate file. If set, .client_key must also be set.
234+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
235235
# If omitted or null, mTLS is not used.
236-
client_certificate: /app/cert.pem
236+
client_certificate_file: /app/cert.pem
237237
# Configure headers. Entries have higher priority than entries from .headers_list.
238238
# If an entry's .value is null, the entry is ignored.
239239
headers:
@@ -276,18 +276,18 @@ meter_provider:
276276
# Configure endpoint.
277277
# If omitted or null, http://localhost:4317 is used.
278278
endpoint: http://localhost:4317
279-
# Configure certificate.
280-
# Absolute path to certificate file.
279+
# Configure certificate used to verify a server's TLS credentials.
280+
# Absolute path to certificate file in PEM format.
281281
# If omitted or null, system default certificate verification is used for secure connections.
282-
certificate: /app/cert.pem
282+
certificate_file: /app/cert.pem
283283
# Configure mTLS private client key.
284-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
284+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
285285
# If omitted or null, mTLS is not used.
286-
client_key: /app/cert.pem
286+
client_key_file: /app/cert.pem
287287
# Configure mTLS client certificate.
288-
# Absolute path to certificate file. If set, .client_key must also be set.
288+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
289289
# If omitted or null, mTLS is not used.
290-
client_certificate: /app/cert.pem
290+
client_certificate_file: /app/cert.pem
291291
# Configure headers. Entries have higher priority than entries from .headers_list.
292292
# If an entry's .value is null, the entry is ignored.
293293
headers:
@@ -465,18 +465,18 @@ tracer_provider:
465465
# Configure endpoint, including the trace specific path.
466466
# If omitted or null, http://localhost:4318/v1/traces is used.
467467
endpoint: http://localhost:4318/v1/traces
468-
# Configure certificate.
469-
# Absolute path to certificate file.
468+
# Configure certificate used to verify a server's TLS credentials.
469+
# Absolute path to certificate file in PEM format.
470470
# If omitted or null, system default certificate verification is used for secure connections.
471-
certificate: /app/cert.pem
471+
certificate_file: /app/cert.pem
472472
# Configure mTLS private client key.
473-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
473+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
474474
# If omitted or null, mTLS is not used.
475-
client_key: /app/cert.pem
475+
client_key_file: /app/cert.pem
476476
# Configure mTLS client certificate.
477-
# Absolute path to certificate file. If set, .client_key must also be set.
477+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
478478
# If omitted or null, mTLS is not used.
479-
client_certificate: /app/cert.pem
479+
client_certificate_file: /app/cert.pem
480480
# Configure headers. Entries have higher priority than entries from .headers_list.
481481
# If an entry's .value is null, the entry is ignored.
482482
headers:
@@ -507,18 +507,18 @@ tracer_provider:
507507
# Configure endpoint.
508508
# If omitted or null, http://localhost:4317 is used.
509509
endpoint: http://localhost:4317
510-
# Configure certificate.
511-
# Absolute path to certificate file.
510+
# Configure certificate used to verify a server's TLS credentials.
511+
# Absolute path to certificate file in PEM format.
512512
# If omitted or null, system default certificate verification is used for secure connections.
513-
certificate: /app/cert.pem
513+
certificate_file: /app/cert.pem
514514
# Configure mTLS private client key.
515-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
515+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
516516
# If omitted or null, mTLS is not used.
517-
client_key: /app/cert.pem
517+
client_key_file: /app/cert.pem
518518
# Configure mTLS client certificate.
519-
# Absolute path to certificate file. If set, .client_key must also be set.
519+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
520520
# If omitted or null, mTLS is not used.
521-
client_certificate: /app/cert.pem
521+
client_certificate_file: /app/cert.pem
522522
# Configure headers. Entries have higher priority than entries from .headers_list.
523523
# If an entry's .value is null, the entry is ignored.
524524
headers:

‎examples/sdk-config.yaml‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,18 @@ tracer_provider:
6565
# Configure endpoint, including the trace specific path.
6666
# If omitted or null, http://localhost:4318/v1/traces is used.
6767
endpoint: http://localhost:4318/v1/traces
68-
# Configure certificate.
69-
# Absolute path to certificate file.
68+
# Configure certificate used to verify a server's TLS credentials.
69+
# Absolute path to certificate file in PEM format.
7070
# If omitted or null, system default certificate verification is used for secure connections.
71-
certificate:
71+
certificate_file:
7272
# Configure mTLS private client key.
73-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
73+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
7474
# If omitted or null, mTLS is not used.
75-
client_key:
75+
client_key_file:
7676
# Configure mTLS client certificate.
77-
# Absolute path to certificate file. If set, .client_key must also be set.
77+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
7878
# If omitted or null, mTLS is not used.
79-
client_certificate:
79+
client_certificate_file:
8080
# Configure compression.
8181
# Values include: gzip, none. Implementations may support other compression algorithms.
8282
# If omitted or null, none is used.
@@ -166,18 +166,18 @@ meter_provider:
166166
# Configure endpoint, including the metric specific path.
167167
# If omitted or null, http://localhost:4318/v1/metrics is used.
168168
endpoint: http://localhost:4318/v1/metrics
169-
# Configure certificate.
170-
# Absolute path to certificate file.
169+
# Configure certificate used to verify a server's TLS credentials.
170+
# Absolute path to certificate file in PEM format.
171171
# If omitted or null, system default certificate verification is used for secure connections.
172-
certificate:
172+
certificate_file:
173173
# Configure mTLS private client key.
174-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
174+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
175175
# If omitted or null, mTLS is not used.
176-
client_key:
176+
client_key_file:
177177
# Configure mTLS client certificate.
178-
# Absolute path to certificate file. If set, .client_key must also be set.
178+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
179179
# If omitted or null, mTLS is not used.
180-
client_certificate:
180+
client_certificate_file:
181181
# Configure compression.
182182
# Values include: gzip, none. Implementations may support other compression algorithms.
183183
# If omitted or null, none is used.
@@ -227,18 +227,18 @@ logger_provider:
227227
# Configure exporter to be OTLP with HTTP transport.
228228
otlp_http:
229229
endpoint: http://localhost:4318/v1/logs
230-
# Configure certificate.
231-
# Absolute path to certificate file.
230+
# Configure certificate used to verify a server's TLS credentials.
231+
# Absolute path to certificate file in PEM format.
232232
# If omitted or null, system default certificate verification is used for secure connections.
233-
certificate:
233+
certificate_file:
234234
# Configure mTLS private client key.
235-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
235+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
236236
# If omitted or null, mTLS is not used.
237-
client_key:
237+
client_key_file:
238238
# Configure mTLS client certificate.
239-
# Absolute path to certificate file. If set, .client_key must also be set.
239+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
240240
# If omitted or null, mTLS is not used.
241-
client_certificate:
241+
client_certificate_file:
242242
# Configure compression.
243243
# Values include: gzip, none. Implementations may support other compression algorithms.
244244
# If omitted or null, none is used.

‎examples/sdk-migration-config.yaml‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -98,18 +98,18 @@ tracer_provider:
9898
# Configure endpoint, including the trace specific path.
9999
# If omitted or null, http://localhost:4318/v1/traces is used.
100100
endpoint: ${OTEL_EXPORTER_OTLP_TRACES_ENDPOINT:-http://localhost:4318/v1/traces}
101-
# Configure certificate.
102-
# Absolute path to certificate file.
101+
# Configure certificate used to verify a server's TLS credentials.
102+
# Absolute path to certificate file in PEM format.
103103
# If omitted or null, system default certificate verification is used for secure connections.
104-
certificate: ${OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE}
104+
certificate_file: ${OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE}
105105
# Configure mTLS private client key.
106-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
106+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
107107
# If omitted or null, mTLS is not used.
108-
client_key: ${OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY}
108+
client_key_file: ${OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY}
109109
# Configure mTLS client certificate.
110-
# Absolute path to certificate file. If set, .client_key must also be set.
110+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
111111
# If omitted or null, mTLS is not used.
112-
client_certificate: ${OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE}
112+
client_certificate_file: ${OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE}
113113
# Configure compression.
114114
# Values include: gzip, none. Implementations may support other compression algorithms.
115115
# If omitted or null, none is used.
@@ -205,18 +205,18 @@ meter_provider:
205205
# Configure endpoint, including the metric specific path.
206206
# If omitted or null, http://localhost:4318/v1/metrics is used.
207207
endpoint: ${OTEL_EXPORTER_OTLP_METRICS_ENDPOINT:-http://localhost:4318/v1/metrics}
208-
# Configure certificate.
209-
# Absolute path to certificate file.
208+
# Configure certificate used to verify a server's TLS credentials.
209+
# Absolute path to certificate file in PEM format.
210210
# If omitted or null, system default certificate verification is used for secure connections.
211-
certificate: ${OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE}
211+
certificate_file: ${OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE}
212212
# Configure mTLS private client key.
213-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
213+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
214214
# If omitted or null, mTLS is not used.
215-
client_key: ${OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY}
215+
client_key_file: ${OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY}
216216
# Configure mTLS client certificate.
217-
# Absolute path to certificate file. If set, .client_key must also be set.
217+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
218218
# If omitted or null, mTLS is not used.
219-
client_certificate: ${OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE}
219+
client_certificate_file: ${OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE}
220220
# Configure compression.
221221
# Values include: gzip, none. Implementations may support other compression algorithms.
222222
# If omitted or null, none is used.
@@ -270,18 +270,18 @@ logger_provider:
270270
# Configure exporter to be OTLP with HTTP transport.
271271
otlp_http:
272272
endpoint: ${OTEL_EXPORTER_OTLP_LOGS_ENDPOINT:-http://localhost:4318/v1/logs}
273-
# Configure certificate.
274-
# Absolute path to certificate file.
273+
# Configure certificate used to verify a server's TLS credentials.
274+
# Absolute path to certificate file in PEM format.
275275
# If omitted or null, system default certificate verification is used for secure connections.
276-
certificate: ${OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE}
276+
certificate_file: ${OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE}
277277
# Configure mTLS private client key.
278-
# Absolute path to client key in PEM format. If set, .client_certificate must also be set.
278+
# Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
279279
# If omitted or null, mTLS is not used.
280-
client_key: ${OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY}
280+
client_key_file: ${OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY}
281281
# Configure mTLS client certificate.
282-
# Absolute path to certificate file. If set, .client_key must also be set.
282+
# Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
283283
# If omitted or null, mTLS is not used.
284-
client_certificate: ${OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE}
284+
client_certificate_file: ${OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE}
285285
# Configure compression.
286286
# Values include: gzip, none. Implementations may support other compression algorithms.
287287
# If omitted or null, none is used.

0 commit comments

Comments
 (0)