Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Commit 6ffd6c6

Browse files
niksajakovljevicniksajakovljevic
committed
Rename CLI flag to control GRPC server used for Jaeger and OTEL traces
New flag name: `tracing.grpc.server-address`
1 parent ac265a8 commit 6ffd6c6

File tree

5 files changed

+13
-10
lines changed

5 files changed

+13
-10
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ We use the following categories for changes:
2323
### Changed
2424

2525
- Helm chart code was migrated to https://github.com/timescale/helm-charts [#1562]
26+
- Deprecate flag `tracing.otlp.server-address` in favour of `tracing.grpc.server-address` [#1588]
2627

2728
### Fixed
2829
- Make Jaeger Event queryable using name and tags [#1553]

‎docs/configuration.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@ The following subsections cover all CLI flags which promscale supports. You can
4848
| config | string | config.yml | YAML configuration file path for Promscale. |
4949
| enable-feature | string | "" | Enable one or more experimental promscale features (as a comma-separated list). Current experimental features are `promql-at-modifier`, `promql-negative-offset` and `promql-per-step-stats`. For more information, please consult the following resources: [promql-at-modifier](https://prometheus.io/docs/prometheus/latest/feature_flags/#modifier-in-promql), [promql-negative-offset](https://prometheus.io/docs/prometheus/latest/feature_flags/#negative-offset-in-promql), [promql-per-step-stats](https://prometheus.io/docs/prometheus/latest/feature_flags/#per-step-stats). |
5050
| thanos.store-api.server-address | string | "" (disabled) | Address to listen on for Thanos Store API endpoints. |
51-
| tracing.otlp.server-address | string | ":9202" | Address |
52-
| to listen on for OpenTelemetry OTLP GRPC server. | | | |
51+
| tracing.otlp.server-address | string | ":9202" | GRPC server address to listen on for Jaeger and OTEL traces(DEPRECATED: use `tracing.grpc.server-address` instead). |
5352
| | | | |
53+
| | | | |
54+
| tracing.grpc.server-address | string | ":9202" | GRPC server address to listen on for Jaeger and OTEL traces. |
5455
| tracing.async-acks | boolean | false | |
5556
| Acknowledge asynchronous inserts. If this is true, the inserter will not wait after insertion of | | | |
5657
| traces data in the database. This increases throughput at the cost of a small chance of data loss | | | |

‎pkg/runner/flags.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828
type Config struct {
2929
ListenAddr string
3030
ThanosStoreAPIListenAddr string
31-
OTLPGRPCListenAddr string
31+
TracingGRPCListenAddr string
3232
PgmodelCfg pgclient.Config
3333
LogCfg log.Config
3434
TracerCfg tracer.Config
@@ -136,7 +136,8 @@ func ParseFlags(cfg *Config, args []string) (*Config, error) {
136136
fs.StringVar(&cfg.ConfigFile, "config", "config.yml", "YAML configuration file path for Promscale.")
137137
fs.StringVar(&cfg.ListenAddr, "web.listen-address", ":9201", "Address to listen on for web endpoints.")
138138
fs.StringVar(&cfg.ThanosStoreAPIListenAddr, "thanos.store-api.server-address", "", "Address to listen on for Thanos Store API endpoints.")
139-
fs.StringVar(&cfg.OTLPGRPCListenAddr, "tracing.otlp.server-address", ":9202", "Address to listen on for OpenTelemetry OTLP GRPC server.")
139+
fs.StringVar(&cfg.TracingGRPCListenAddr, "tracing.otlp.server-address", ":9202", "GRPC server address to listen on for Jaeger and OTEL traces(DEPRECATED: use `tracing.grpc.server-address` instead).") //TODO: remove this flag at some point
140+
fs.StringVar(&cfg.TracingGRPCListenAddr, "tracing.grpc.server-address", ":9202", "GRPC server address to listen on for Jaeger and OTEL traces.")
140141
fs.StringVar(&corsOriginFlag, "web.cors-origin", ".*", `Regex for CORS origin. It is fully anchored. Example: 'https?://(domain1|domain2)\.com'`)
141142
fs.DurationVar(&cfg.ThroughputInterval, "telemetry.log.throughput-report-interval", time.Second, "Duration interval at which throughput should be reported. Setting duration to `0` will disable reporting throughput, otherwise, an interval with unit must be provided, e.g. `10s` or `3m`.")
142143
fs.StringVar(&cfg.DatasetConfig, "startup.dataset.config", "", "Dataset configuration in YAML format for Promscale. It is used for setting various dataset configuration like default metric chunk interval")

‎pkg/runner/flags_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ func TestParseFlags(t *testing.T) {
6565
name: "enable disabled-features",
6666
args: []string{"-enable-feature", "promql-at-modifier,tracing", "-tracing.otlp.server-address", ":8080"},
6767
result: func(c Config) Config {
68-
c.OTLPGRPCListenAddr = ":8080"
68+
c.TracingGRPCListenAddr = ":8080"
6969
c.PromQLCfg.PromscaleEnabledFeatureList = []string{"promql-at-modifier", "tracing"}
7070
c.PromQLCfg.EnabledFeatureMap = map[string]struct{}{
7171
"promql-at-modifier": {},
@@ -157,7 +157,7 @@ func TestParseFlags(t *testing.T) {
157157
name: "enable feature should populate map of enabled features",
158158
args: []string{"-enable-feature", "tracing,promql-at-modifier,promql-negative-offset,promql-per-step-stats", "-tracing.otlp.server-address", "someaddress"},
159159
result: func(c Config) Config {
160-
c.OTLPGRPCListenAddr = "someaddress"
160+
c.TracingGRPCListenAddr = "someaddress"
161161
c.PromQLCfg.EnabledFeatureMap = map[string]struct{}{
162162
"promql-at-modifier": {},
163163
"promql-negative-offset": {},

‎pkg/runner/runner.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,15 @@ func Run(cfg *Config) error {
241241

242242
group.Add(
243243
func() error {
244-
listener, err := net.Listen("tcp", cfg.OTLPGRPCListenAddr)
244+
listener, err := net.Listen("tcp", cfg.TracingGRPCListenAddr)
245245
if err != nil {
246-
log.Error("msg", "Listening for OpenTelemetry OTLP GRPC server failed", "err", err)
246+
log.Error("msg", "Failed creating server listener for Jaeger and OTEL traces", "err", err)
247247
return err
248248
}
249-
log.Info("msg", "Started OpenTelemetry OTLP GRPC server", "listening-port", cfg.OTLPGRPCListenAddr)
249+
log.Info("msg", "Started GRPC server for Jaeger and OTEL traces", "listening-port", cfg.TracingGRPCListenAddr)
250250
return grpcServer.Serve(listener)
251251
}, func(error) {
252-
log.Info("msg", "Stopping OpenTelemetry OTLP GRPC server")
252+
log.Info("msg", "Stopping GRPC server for Jaeger and OTEL traces")
253253
grpcServer.Stop()
254254
},
255255
)

0 commit comments

Comments
 (0)