Skip to content

Commit ff4fc59

Browse files
committed
Add README instructions
Signed-off-by: Jonas De Gendt <[email protected]>
1 parent 3aa6c1f commit ff4fc59

File tree

2 files changed

+47
-1
lines changed

2 files changed

+47
-1
lines changed

charts/tempo-distributed/README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -993,7 +993,7 @@ The memcached default args are removed and should be provided manually. The sett
993993
| traces.opencensus.enabled | bool | `false` | Enable Tempo to ingest Open Census traces |
994994
| traces.opencensus.receiverConfig | object | `{}` | Open Census receiver config |
995995
| traces.otlp.grpc.enabled | bool | `false` | Enable Tempo to ingest Open Telemetry GRPC traces |
996-
| traces.otlp.grpc.port | int | `4317` | |
996+
| traces.otlp.grpc.port | int | `4317` | Default OTLP gRPC port |
997997
| traces.otlp.grpc.receiverConfig | object | `{}` | GRPC receiver advanced config |
998998
| traces.otlp.http.enabled | bool | `false` | Enable Tempo to ingest Open Telemetry HTTP traces |
999999
| traces.otlp.http.receiverConfig | object | `{}` | HTTP receiver advanced config |
@@ -1135,3 +1135,26 @@ config: |
11351135
service: memcached-client
11361136
timeout: 500ms
11371137
```
1138+
1139+
### Enabling gRPC Open Telemetry
1140+
1141+
gRPC for Open Telemetry is disabled by default, simply flip the bool in the `traces` block to turn it on.
1142+
1143+
If you have enabled the gateway as well, this will let you push traces using the default Open Telemetry API path (`/opentelemetry.proto.collector.trace.v1.TraceService/Export`), on the 4317 port. This port can be overwriten as well in the values.
1144+
1145+
```yaml
1146+
traces:
1147+
otlp:
1148+
http:
1149+
# -- Enable Tempo to ingest Open Telemetry HTTP traces
1150+
enabled: false
1151+
# -- HTTP receiver advanced config
1152+
receiverConfig: {}
1153+
grpc:
1154+
# -- Enable Tempo to ingest Open Telemetry GRPC traces
1155+
enabled: true
1156+
# -- GRPC receiver advanced config
1157+
receiverConfig: {}
1158+
# -- Default OTLP gRPC port
1159+
port: 4317
1160+
```

charts/tempo-distributed/README.md.gotmpl

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,3 +391,26 @@ config: |
391391
service: memcached-client
392392
timeout: 500ms
393393
```
394+
395+
### Enabling gRPC Open Telemetry
396+
397+
gRPC for Open Telemetry is disabled by default, simply flip the bool in the `traces` block to turn it on.
398+
399+
If you have enabled the gateway as well, this will let you push traces using the default Open Telemetry API path (`/opentelemetry.proto.collector.trace.v1.TraceService/Export`), on the 4317 port. This port can be overwriten as well in the values.
400+
401+
```yaml
402+
traces:
403+
otlp:
404+
http:
405+
# -- Enable Tempo to ingest Open Telemetry HTTP traces
406+
enabled: false
407+
# -- HTTP receiver advanced config
408+
receiverConfig: {}
409+
grpc:
410+
# -- Enable Tempo to ingest Open Telemetry GRPC traces
411+
enabled: true
412+
# -- GRPC receiver advanced config
413+
receiverConfig: {}
414+
# -- Default OTLP gRPC port
415+
port: 4317
416+
```

0 commit comments

Comments
 (0)