Remove references to jaeger-agent (#757)

## Which problem is this PR solving? - Part of jaegertracing/jaeger#4739 ## Description of the changes - Remove references to `jaeger-agent` everywhere except FAQ and Operator - Operator page needs to be cleaned-up separately, perhaps it needs changes in the operator to support OTEL Collector as the agent ## How was this change tested? - CI --------- Signed-off-by: Yuri Shkuro <[email protected]>
jaegertracing · Oct 15, 2024 · e942c23 · e942c23
1 parent 6995017
commit e942c23
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 207 deletions.
diff --git a/content/docs/next-release/apis.md b/content/docs/next-release/apis.md
@@ -15,7 +15,7 @@ Since Jaeger v1.32, **jaeger-collector** and **jaeger-query** Service ports that
 
 ## Span reporting APIs
 
-**jaeger-agent** and **jaeger-collector** are the two components of the Jaeger backend that can receive spans. At this time they support two sets of non-overlapping APIs.
+**jaeger-collector** is the component of the Jaeger backend that can receive spans. At this time it supports two sets of non-overlapping APIs.
 
 ### OpenTelemetry Protocol (stable)
 
@@ -31,21 +31,17 @@ The OTLP data is accepted in these formats: (1) binary gRPC, (2) Protobuf over H
 [otlp-rcvr]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/otlpreceiver/README.md
 [otlp]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md
 
-### Thrift over UDP (stable)
-
-**jaeger-agent** can only receive spans over UDP in Thrift format. The primary API is a UDP packet that contains a Thrift-encoded `Batch` struct defined in the [jaeger.thrift] IDL file, located in the [jaeger-idl] repository. Most Jaeger Clients use Thrift's `compact` encoding, however some client libraries do not support it (notably, Node.js) and use Thrift's `binary` encoding (sent to  a different UDP port). **jaeger-agent**'s API is defined by the [agent.thrift] IDL file.
-
-For legacy reasons, **jaeger-agent** also accepts spans over UDP in Zipkin format, however, only very old versions of Jaeger clients can send data in that format and it is officially deprecated.
-
 ### Protobuf via gRPC (stable)
 
-In a typical Jaeger deployment, **jaeger-agent**s receive spans from Clients and forward them to **jaeger-collector**s. Since Jaeger v1.11, the official and recommended protocol between **jaeger-agent**s and **jaeger-collector**s is `jaeger.api_v2.CollectorService` gRPC endpoint defined in [collector.proto] IDL file. The same endpoint can be used to submit trace data from SDKs directly to **jaeger-collector**.
+**Deprecated**: we recommend the OpenTelemetry protocol.
+
+Since Jaeger v1.11, the official protocol between user applications and **jaeger-collector**s is `jaeger.api_v2.CollectorService` gRPC endpoint defined in [collector.proto] IDL file. The same endpoint can be used to submit trace data from SDKs directly to **jaeger-collector**.
 
 ### Thrift over HTTP (stable)
 
-In some cases it is not feasible to deploy **jaeger-agent** next to the application, for example, when the application code is running as a serverless function. In these scenarios the SDKs can be configured to submit spans directly to **jaeger-collector**s over HTTP/HTTPS.
+**Deprecated**: we recommend the OpenTelemetry protocol.
 
-The same [jaeger.thrift] payload can be submitted in an HTTP POST request to the  `/api/traces` endpoint, for example, `https://jaeger-collector:14268/api/traces`. The `Batch` struct needs to be encoded using Thrift's `binary` encoding, and the HTTP request should specify the content type header:
+The payload in [jaeger.thrift] format can be submitted in an HTTP POST request to the  `/api/traces` endpoint, for example, `https://jaeger-collector:14268/api/traces`. The `Batch` struct needs to be encoded using Thrift's `binary` encoding, and the HTTP request should specify the content type header:
 
 ```
 Content-Type: application/vnd.apache.thrift.binary
@@ -83,16 +79,14 @@ When using the `grpc` storage type (a.k.a. [remote storage](../deployment/#remot
 
 This API supports Jaeger's [Remote Sampling](../sampling/#remote-sampling) protocol, defined in the [sampling.proto] IDL file.
 
-Both **jaeger-agent** and **jaeger-collector** implement the API. See [Remote Sampling](../sampling/#remote-sampling) for details on how to configure the Collector with sampling strategies. **jaeger-agent** is merely acting as a proxy to **jaeger-collector**.
+**jaeger-collector** implements this API. See [Remote Sampling](../sampling/#remote-sampling) for details on how to configure the Collector with sampling strategies.
 
 The following table lists different endpoints and formats that can be used to query for sampling strategies. The official HTTP/JSON endpoints use standard [Protobuf-to-JSON mapping](https://developers.google.com/protocol-buffers/docs/proto3#json).
 
 Component | Port  | Endpoint          | Format    | Notes
 --------- | ----- | ----------------- | --------- | -----
 Collector | 14268 | `/api/sampling`   | HTTP/JSON | Recommended for most SDKs
 Collector | 14250 | [sampling.proto]  | gRPC      | For SDKs that want to use gRPC (e.g. OpenTelemetry Java SDK)
-Agent     | 5778  | `/sampling`       | HTTP/JSON | Recommended for most SDKs if the Agent is used in a deployment
-Agent     | 5778  | `/` (deprecated)  | HTTP/JSON | Legacy format, with enums encoded as numbers. **Not recommended.**
 
 **Examples**
 
@@ -102,19 +96,10 @@ $ go run ./cmd/all-in-one \
   --sampling.strategies-file=cmd/all-in-one/sampling_strategies.json
 ```
 
-Query different endpoints in another terminal:
+Query the endpoint in another terminal:
 ```shell
-# Collector
 $ curl "http://localhost:14268/api/sampling?service=foo"
 {"strategyType":"PROBABILISTIC","probabilisticSampling":{"samplingRate":1}}
-
-# Agent
-$ curl "http://localhost:5778/sampling?service=foo"
-{"strategyType":"PROBABILISTIC","probabilisticSampling":{"samplingRate":1}}
-
-# Agent, legacy endpoint / (not recommended)
-$ curl "http://localhost:5778/?service=foo"
-{"strategyType":0,"probabilisticSampling":{"samplingRate":1}}
 ```
 
 ## Service dependencies graph (internal)
@@ -134,7 +119,6 @@ Please refer to the [SPM Documentation](../spm#api)
 
 [jaeger-idl]: https://github.com/jaegertracing/jaeger-idl/
 [jaeger.thrift]: https://github.com/jaegertracing/jaeger-idl/blob/main/thrift/jaeger.thrift
-[agent.thrift]: https://github.com/jaegertracing/jaeger-idl/blob/main/thrift/agent.thrift
 [sampling.thrift]: https://github.com/jaegertracing/jaeger-idl/blob/main/thrift/sampling.thrift
 [collector.proto]: https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/collector.proto
 [query.proto]: https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/query.proto

diff --git a/content/docs/next-release/architecture.md b/content/docs/next-release/architecture.md
@@ -104,14 +104,6 @@ Instrumentation typically should not depend on specific tracing SDKs, but only o
 
 The instrumentation is designed to be always on in production. To minimize  overhead, the SDKs employ various sampling strategies. When a trace is sampled, the profiling span data is captured and transmitted to the Jaeger backend. When a trace is not sampled, no profiling data is collected at all, and the calls to the tracing API are short-circuited to incur a minimal amount of overhead. For more information, please refer to the [Sampling](../sampling/) page.
 
-### Agent
-
-{{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
-{{< /warning >}}
-
-**jaeger-agent** is a network daemon that listens for spans sent over UDP, which are batched and sent to the collector. It is designed to be deployed to all hosts as an infrastructure component. The agent abstracts the routing and discovery of the collectors away from the client. **jaeger-agent** is **not** a required component.
-
 ### Collector
 
 **jaeger-collector** receives traces, runs them through a processing pipeline for validation and clean-up/enrichment, and stores them in a storage backend. Jaeger comes with built-in support for several storage backends (see [Deployment](../deployment)), as well as extensible plugin framework for implementing custom storage plugins.

diff --git a/content/docs/next-release/deployment.md b/content/docs/next-release/deployment.md
@@ -23,7 +23,6 @@ The main Jaeger backend components are released as Docker images on [Docker Hub]
 Component             | Docker Hub                                                                                                   | Quay
 --------------------- | -------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------
 **jaeger-all-in-one**      | [hub.docker.com/r/jaegertracing/all-in-one/](https://hub.docker.com/r/jaegertracing/all-in-one/)         | [quay.io/repository/jaegertracing/all-in-one](https://quay.io/repository/jaegertracing/all-in-one)
-**jaeger-agent**      | [hub.docker.com/r/jaegertracing/jaeger-agent/](https://hub.docker.com/r/jaegertracing/jaeger-agent/)         | [quay.io/repository/jaegertracing/jaeger-agent](https://quay.io/repository/jaegertracing/jaeger-agent)
 **jaeger-collector**  | [hub.docker.com/r/jaegertracing/jaeger-collector/](https://hub.docker.com/r/jaegertracing/jaeger-collector/) | [quay.io/repository/jaegertracing/jaeger-collector](https://quay.io/repository/jaegertracing/jaeger-collector)
 **jaeger-query**      | [hub.docker.com/r/jaegertracing/jaeger-query/](https://hub.docker.com/r/jaegertracing/jaeger-query/)         | [quay.io/repository/jaegertracing/jaeger-query](https://quay.io/repository/jaegertracing/jaeger-query)
 **jaeger-ingester**   | [hub.docker.com/r/jaegertracing/jaeger-ingester/](https://hub.docker.com/r/jaegertracing/jaeger-ingester/)   | [quay.io/repository/jaegertracing/jaeger-ingester](https://quay.io/repository/jaegertracing/jaeger-ingester)
@@ -65,7 +64,7 @@ Command line option                | Environment variable
 
 ## All-in-one
 
-Jaeger all-in-one is a special distribution that combines three Jaeger components, [agent](#agent), [collector](#collector), and [query service/UI](#query-service--ui), in a single binary or container image. It is useful for single-node deployments where your trace volume is light enough to be handled by a single instance. By default, all-in-one starts with `memory` storage, meaning it will lose all data upon restart. All other [span storage backends](#span-storage-backends) can also be used with all-in-one, but `memory` and `badger` are exclusive to all-in-one because they cannot be shared between instances.
+Jaeger all-in-one is a special distribution that combines three Jaeger components, [collector](#collector), and [query service/UI](#query-service--ui), in a single binary or container image. It is useful for single-node deployments where your trace volume is light enough to be handled by a single instance. By default, all-in-one starts with `memory` storage, meaning it will lose all data upon restart. All other [span storage backends](#span-storage-backends) can also be used with all-in-one, but `memory` and `badger` are exclusive to all-in-one because they cannot be shared between instances.
 
 All-in-one listens to the same ports as the components it contains (described below), with the exception of the admin port.
 
@@ -94,64 +93,6 @@ docker run -d --name jaeger \
 
 You can navigate to `http://localhost:16686` to access the Jaeger UI.
 
-## Agent
-
-{{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. See the [Architecture](../architecture) page for alternative deployment options.
-{{< /warning >}}
-
-**jaeger-agent** is designed to receive tracing data in Thrift format over UDP and run locally on each host, either as a host agent / daemon or as an application sidecar. **jaeger-agent** exposes the following ports:
-
-Port  | Protocol | Function
------ | -------  | ---
-6831  | UDP      | Accepts [jaeger.thrift][jaeger-thrift] in `compact` Thrift protocol used by most current Jaeger clients.
-6832  | UDP      | Accepts [jaeger.thrift][jaeger-thrift] in `binary` Thrift protocol used by Node.js Jaeger client (because [thriftrw][thriftrw] npm package does not support `compact` protocol).
-5778  | HTTP     | Serves SDK configs, namely sampling strategies at `/sampling` (see [Remote Sampling](../sampling/#remote-sampling)).
-5775  | UDP      | Accepts [zipkin.thrift][zipkin-thrift] in `compact` Thrift protocol (deprecated; only used by very old Jaeger clients, circa 2016).
-14271 | HTTP     | Admin port: health check at `/` and metrics at `/metrics`.
-
-It can be executed directly on the host or via Docker, as follows:
-
-```sh
-## make sure to expose only the ports you use in your deployment scenario!
-docker run \
-  --rm \
-  -p6831:6831/udp \
-  -p6832:6832/udp \
-  -p5778:5778/tcp \
-  -p5775:5775/udp \
-  jaegertracing/jaeger-agent:{{< currentVersion >}}
-```
-
-### Discovery System Integration
-
-**jaeger-agent**s can connect point-to-point to a single **jaeger-collector** address, which could be
-load balanced by another infrastructure component (e.g. DNS) across multiple **jaeger-collector**s.
-**jaeger-agent** can also be configured with a static list of **jaeger-collector** addresses.
-
-On Docker, a command like the following can be used:
-
-```sh
-docker run \
-  --rm \
-  -p5775:5775/udp \
-  -p6831:6831/udp \
-  -p6832:6832/udp \
-  -p5778:5778/tcp \
-  jaegertracing/jaeger-agent:{{< currentVersion >}} \
-  --reporter.grpc.host-port=jaeger-collector.jaeger-infra.svc:14250
-```
-
-When using gRPC, you have several options for load balancing and name resolution:
-
-* Single connection and no load balancing. This is the default if you specify a single `host:port`. (example: `--reporter.grpc.host-port=jaeger-collector.jaeger-infra.svc:14250`)
-* Static list of hostnames and round-robin load balancing. This is what you get with a comma-separated list of addresses. (example: `reporter.grpc.host-port=jaeger-collector1:14250,jaeger-collector2:14250,jaeger-collector3:14250`)
-* Dynamic DNS resolution and round-robin load balancing. To get this behavior, prefix the address with `dns:///` and gRPC will attempt to resolve the hostname using SRV records (for [external load balancing](https://github.com/grpc/grpc/blob/master/doc/load-balancing.md)), TXT records (for [service configs](https://github.com/grpc/grpc/blob/master/doc/service_config.md)), and A records. Refer to the [gRPC Name Resolution docs](https://github.com/grpc/grpc/blob/master/doc/naming.md) and the [dns_resolver.go implementation](https://github.com/grpc/grpc-go/blob/master/resolver/dns/dns_resolver.go) for more info. (example: `--reporter.grpc.host-port=dns:///jaeger-collector.jaeger-infra.svc:14250`)
-
-### Agent level tags
-
-Jaeger supports agent level tags, that can be added to the process tags of all spans passing through **jaeger-agent**. This is supported through the command line flag `--agent.tags=key1=value1,key2=value2,...,keyn=valuen`. Tags can also be set through an environment flag like so - `--agent.tags=key=${envFlag:defaultValue}` - The tag value will be set to the value of the `envFlag` environment key and `defaultValue` if not set.
-
 ## Collector
 
 **jaeger-collector**s are stateless and thus many instances of **jaeger-collector** can be run in parallel.
@@ -171,7 +112,7 @@ At default settings **jaeger-collector** exposes the following ports:
 | 14269 | HTTP     | `/`      | Admin port: health check (`GET`).
 |       |          | `/metrics` | Prometheus-style metrics (`GET`).
 | 9411  | HTTP     | `/api/v1/spans` and `/api/v2/spans` | Accepts Zipkin spans in Thrift, JSON and Proto (disabled by default).
-| 14250 | gRPC     | n/a      | Used by **jaeger-agent** to send spans in [model.proto][] Protobuf format.
+| 14250 | gRPC     | n/a      | Accepts spans in [model.proto][] Protobuf format.
 
 ## Ingester
 

diff --git a/content/docs/next-release/external-guides.md b/content/docs/next-release/external-guides.md
@@ -23,10 +23,8 @@ weight: 13
 
 ## Deployment
 
-* [Running Jaeger on bare metal](https://medium.com/jaegertracing/running-jaeger-agent-on-bare-metal-d1fc47d31fab) by Juraci Paixão Kröhling
 * [Protecting Jaeger UI with an OAuth sidecar Proxy](https://medium.com/jaegertracing/protecting-jaeger-ui-with-an-oauth-sidecar-proxy-34205cca4bb1) by Juraci Paixão Kröhling
 * [Jaeger and multi-tenancy](https://medium.com/jaegertracing/jaeger-and-multitenancy-99dfa1d49dc0) by Juraci Paixão Kröhling
-* [Deployment strategies for the Jaeger Agent](https://medium.com/jaegertracing/deployment-strategies-for-the-jaeger-agent-1d6f91796d09) by Juraci Paixão Kröhling
 * [How to deploy Jaeger on AWS: a comprehensive step-by-step guide](https://www.aspecto.io/blog/how-to-deploy-jaeger-on-aws-a-comprehensive-step-by-step-guide/) by Tom Zach
 
 ## Jaeger Performance Tuning