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

Commit b9039c7

Browse files
committed
Remove obsoleted jaeger-query-proxy
With upstream support for remote gPRC storage plugins [1], our query proxy is no longer required. Updated documentation to illustrate how to use jaeger standalone. [1]: jaegertracing/jaeger#3383
1 parent c6d6feb commit b9039c7

File tree

7 files changed

+8
-208
lines changed

7 files changed

+8
-208
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
/prom-migrator*
44
/cmd/promscale/promscale
55
/cmd/prom-migrator/prom-migrator
6-
/cmd/jaeger-query-proxy/jaeger-query-proxy
76
/dist
87
/vendor
98
/version.properties

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ We use the following categories for changes:
4343
### Removed
4444
- Remove deprecated `-promql-enable-feature` flag [#964]
4545
- Remove deprecated leader election [#964]
46+
- Remove obsoleted jaeger-query-proxy
4647

4748
### Fixed
4849
- helm-charts: use fixed target port on svc-promscale [#1009]

build/.goreleaser.yml

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,6 @@ builds:
2121
main: ./cmd/prom-migrator/
2222
id: prom-migrator
2323
binary: prom-migrator
24-
- env:
25-
- CGO_ENABLED=0
26-
main: ./cmd/jaeger-query-proxy/
27-
id: jaeger-query-proxy
28-
binary: jaeger-query-proxy
2924

3025
#don't publish scoop but overwrite the weird names
3126
scoop:
@@ -115,17 +110,6 @@ archives:
115110
windows: Windows
116111
386: i386
117112
amd64: x86_64
118-
- id: jaeger-query-proxy
119-
format: binary
120-
builds:
121-
- jaeger-query-proxy
122-
name_template: "{{ .Binary }}_0.0.2_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}{{ if .Mips }}_{{ .Mips }}{{ end }}"
123-
replacements:
124-
darwin: Darwin
125-
linux: Linux
126-
windows: Windows
127-
386: i386
128-
amd64: x86_64
129113
checksum:
130114
name_template: 'checksums.txt'
131115
snapshot:
@@ -182,19 +166,6 @@ dockers:
182166
image_templates:
183167
- "timescale/prom-migrator:0.0.3"
184168
- "timescale/prom-migrator:latest"
185-
- ids: []
186-
skip_push: false
187-
dockerfile: ./build/jaeger-query-proxy/Dockerfile
188-
extra_files:
189-
- .git
190-
- go.sum
191-
- go.mod
192-
- pkg
193-
- cmd
194-
image_templates:
195-
- "timescale/jaeger-query-proxy:0.0.2"
196-
- "timescale/jaeger-query-proxy:latest"
197-
198169

199170
docker_manifests:
200171
- name_template: 'timescale/promscale:{{ .Tag }}'

build/jaeger-query-proxy/Dockerfile

Lines changed: 0 additions & 27 deletions
This file was deleted.

cmd/jaeger-query-proxy/main.go

Lines changed: 0 additions & 101 deletions
This file was deleted.

cmd/jaeger-query-proxy/sample-config.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/tracing.md

Lines changed: 7 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -217,62 +217,22 @@ Then, point your browser to [http://127.0.0.1:8080/] and login with username `ad
217217

218218
### Setting up Jaeger UI
219219

220-
In order for the Jaeger UI to show traces stored in Promscale we leverage Jaeger’s support for [gRPC storage plugins](https://github.com/jaegertracing/jaeger/tree/master/plugin/storage/grpc). Our plugin acts as a simple proxy between Jaeger and Promscale. It does not contain any logic. All the processing work is done in the Promscale Connector.
220+
In order for the Jaeger UI to show traces stored in Promscale we leverage Jaeger’s support for [gRPC storage plugins](https://github.com/jaegertracing/jaeger/tree/master/plugin/storage/grpc).
221221

222-
This plugin only implements the APIs for Jaeger to read traces from Promscale. It does not implement the APIs for Jaeger to write traces to Promscale. To send Jaeger traces to Promscale use the OpenTelemetry Collector instead as explained [here](#jaeger-instrumentation).
222+
To enable Jaeger to use the plugin you need to provide jaeger-query with the following:
223223

224-
Jaeger's gRPC plugin system works by executing the binary for the plugin when enabled in the configuration file. For that reason when deploying as a container, Jaeger and the binary need to be on the same container image. And since Jaeger doesn’t package all gRPC storage plugins in its default Docker images, we provide an image that includes the upstream Jaeger Query component (not the rest since they are not needed) and Promscale’s gRPC storage plugin for Jaeger. The image is available on [DockerHub](https://hub.docker.com/r/timescale/jaeger-query-proxy/tags). We recomment using the `latest` image
225-
226-
To enable Jaeger to use the plugin you need to pass the following parameters:
227-
228-
* `span-storage.type=grpc-plugin`
229-
* `grpc-storage-plugin.binary=<path-to-jaeger-query-proxy-binary>`, pointing to the location of the plugin binary
230-
* `grpc-storage-plugin.configuration-file=<config_file>`, a path pointing to the plugin's configuration file.
224+
* environment variable `SPAN_STORAGE_TYPE=grpc-plugin`
225+
* flag `grpc-storage.server=<promscale-host>:<otlp-grpc-port>`
231226

232227
This is how you would run the container with Docker:
233228

234229
```bash
235-
docker run --name promscale-jaeger -d -p 16686:16686 -v <path-to-plugin-config-file>:/configs/jaeger-promscale-query.yaml --network promscale-timescaledb timescale/jaeger-query-proxy:latest
236-
```
237-
The container already sets the required values for those parameters.
238-
239-
The Jaeger UI would be accessible on port 16686.
240-
241-
If you run Jaeger directly on a host, you first need to download the plugin binary for your system. The binaries are available under the assets of the latest 0.7 Promscale release on [Github](https://github.com/timescale/promscale/releases). Then you have to run the binary as follows:
242-
243-
```bash
244-
./jaeger-query-plugin --span-storage.type=grpc-plugin --grpc-storage-plugin.binary=<path-to-jaeger-query-proxy-binary> --grpc-storage-plugin.configuration-file=<config_file>
245-
```
246-
247-
The parameters in the plugin configuration file are the following (only the first is mandatory):
248-
249-
```yaml
250-
grpc-server: <promscale-host>:<otlp-grpc-port>
251-
#connection-timeout: 5s
252-
#grpc-server-host-override: ""
253-
#cafile: ""
254-
#tls: false
230+
docker run --name jaeger -d -p 16686:16686 -e SPAN_STORAGE_TYPE=grpc-plugin --network promscale-timescaledb jaegertracing/jaeger-query:1.30.0 --grpc-storage.server=<promscale-host>:<otlp-grpc-port>
255231
```
256232

257-
If you followed the instructions described in this document then otlp-grpc-port will be 9202. For example
258-
259-
```yaml
260-
grpc-server: localhost:9202
261-
```
262-
263-
If you run on Kubernetes, create a ConfigMap like the one below
264-
265-
```yaml
266-
​​apiVersion: v1
267-
kind: ConfigMap
268-
metadata:
269-
name: promscale-jaeger
270-
data:
271-
jaeger-promscale-query.yaml: |
272-
grpc-server: <promscale-service>:9202
273-
```
233+
If you followed the instructions described in this document then otlp-grpc-port will be 9202.
274234

275-
Then make this ConfigMap available to the promscale-jaeger container through a volumeMount. Read more on how to do that in the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/configmap/#configmaps-and-pods).
235+
The Jaeger UI will be accessible on port 16686.
276236

277237
### Setting up Grafana
278238

0 commit comments

Comments
 (0)