Skip to content

Commit c6f1aac

Browse files
authored
tracing: update Jaeger instructions, remove 'HTTP tracing' text (#1572)
Jaeger exporter has been deprecated a long time, and we removed it a long time ago - seems I missed some docs back then Part of https://linear.app/sourcegraph/issue/SVC-2059/otel-remove-jaeger-export-option-by-70 Also, it's tracing, not HTTP tracing, and we use tracing extensively for background work
1 parent 2aa5af4 commit c6f1aac

5 files changed

Lines changed: 123 additions & 124 deletions

File tree

docs/self-hosted/deploy/docker-compose/configuration.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ See ["Environment variables in Compose"](https://docs.docker.com/compose/environ
5454
5555
Sourcegraph supports HTTP tracing to help troubleshoot issues. See [Tracing](/self-hosted/observability/tracing) for details.
5656
57-
The base docker-compose.yaml file enables the bundled [otel-collector](https://sourcegraph.com/search?q=repo:%5Egithub%5C.com/sourcegraph/deploy-sourcegraph-docker$+file:docker-compose/docker-compose.yaml+content:%22++otel-collector:%22&patternType=keyword) by default, but a tracing backend needs to be deployed or configured to see HTTP traces.
57+
The base docker-compose.yaml file enables the bundled [otel-collector](https://sourcegraph.com/search?q=repo:%5Egithub%5C.com/sourcegraph/deploy-sourcegraph-docker$+file:docker-compose/docker-compose.yaml+content:%22++otel-collector:%22&patternType=keyword) by default, but a tracing backend needs to be deployed or configured to see traces.
5858
5959
To enable tracing on your instance, you'll need to either:
6060
@@ -65,7 +65,7 @@ Once a tracing backend has been deployed, see our [Tracing](/self-hosted/observa
6565
6666
### Deploy the bundled Jaeger
6767
68-
To deploy the bundled Jaeger web UI to see HTTP trace data, add [Jaeger's docker-compose.yaml override file](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/main/docker-compose/jaeger/docker-compose.yaml) to your deployment command.
68+
To deploy the bundled Jaeger web UI to see trace data, add [Jaeger's docker-compose.yaml override file](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/main/docker-compose/jaeger/docker-compose.yaml) to your deployment command.
6969
7070
```bash
7171
docker compose \
@@ -77,13 +77,13 @@ docker compose \
7777

7878
### Configure an external tracing backend
7979

80-
The bundled otel-collector can be configured to export HTTP traces to an OTel-compatible backend of your choosing.
80+
The bundled otel-collector can be configured to export traces to an OTEL-compatible backend of your choosing.
8181

8282
To customize the otel-collector config file:
8383

84-
- Create a copy of the default config in [otel-collector/config.yaml](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/main/otel-collector/config.yaml)
85-
- Follow the [OpenTelemetry collector configuration guidance](/self-hosted/observability/opentelemetry)
86-
- Edit your `docker-compose.override.yaml` file to mount your custom config file to the `otel-collector` container:
84+
- Create a copy of the default config in [otel-collector/config.yaml](https://github.com/sourcegraph/deploy-sourcegraph-docker/blob/main/otel-collector/config.yaml)
85+
- Follow the [OpenTelemetry collector configuration guidance](/self-hosted/observability/opentelemetry)
86+
- Edit your `docker-compose.override.yaml` file to mount your custom config file to the `otel-collector` container:
8787

8888
```yaml
8989
services:
@@ -99,10 +99,10 @@ services:
9999
100100
Provide your `gitserver` container with SSH / Git configuration needed to connect to some code hosts, by mounting a directory that contains the needed config files into the `gitserver` container, ex.
101101

102-
- `.ssh/config`
103-
- `.ssh/id_rsa.pub`
104-
- `.ssh/id_rsa`
105-
- `.ssh/known_hosts`
102+
- `.ssh/config`
103+
- `.ssh/id_rsa.pub`
104+
- `.ssh/id_rsa`
105+
- `.ssh/known_hosts`
106106

107107
You can also provide other files like `.netrc`, `.gitconfig`, etc. at their respective paths, if needed.
108108

docs/self-hosted/deploy/kubernetes/configure.mdx

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ cAdvisor requires a service account and certain permissions to access and gather
109109

110110
To deploy cAdvisor with privileged access, include the following:
111111

112-
- [monitoring base resources](#monitoring-stack)
113-
- [monitoring/privileged component](#monitoring-stack)
114-
- [privileged component](#privileged)
115-
- [cadvisor component](#deploy-cadvisor)
112+
- [monitoring base resources](#monitoring-stack)
113+
- [monitoring/privileged component](#monitoring-stack)
114+
- [privileged component](#privileged)
115+
- [cadvisor component](#deploy-cadvisor)
116116

117117
```yaml
118118
# instances/$INSTANCE_NAME/kustomization.yaml
@@ -187,12 +187,12 @@ Once a tracing backend has been deployed, see our [Tracing](/self-hosted/observa
187187

188188
### Deploy the bundled OpenTelemetry Collector and Jaeger
189189

190-
The quickest way to get started with HTTP tracing is by deploying our bundled OTel and Jaeger containers together.
190+
The quickest way to get started with HTTP tracing is by deploying our bundled OTEL and Jaeger containers together.
191191

192192
Include the `tracing` component to deploy both OpenTelemetry and Jaeger together. This component also configures the following services:
193193

194-
- `otel-collector` to export to this Jaeger instance
195-
- `grafana` to get metrics from this Jaeger instance
194+
- `otel-collector` to export to this Jaeger instance
195+
- `grafana` to get metrics from this Jaeger instance
196196

197197
```yaml
198198
# instances/$INSTANCE_NAME/kustomization.yaml
@@ -216,7 +216,7 @@ components:
216216

217217
#### Configure a tracing backend
218218

219-
Follow these steps to configure the otel-collector to export traces to an external OTel-compatible backend:
219+
Follow these steps to configure the otel-collector to export traces to an external OTEL-compatible backend:
220220

221221
1. Create a subdirectory called 'patches' within the directory of your overlay
222222
2. Copy and paste the [base/otel-collector/otel-collector.ConfigMap.yaml file](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s@master/-/tree/base/otel-collector/otel-collector.ConfigMap.yaml) to the new [patches subdirectory](/self-hosted/deploy/kubernetes/kustomize/#patches-directory)
@@ -352,11 +352,11 @@ $ cp -R components/custom/resources instances/$INSTANCE_NAME/custom-resources
352352

353353
For example, the following patches update the resources for:
354354

355-
- gitserver
356-
- increase replica count to 2
357-
- adjust resources limits and requests
358-
- pgsql
359-
- increase storage size to 500Gi
355+
- gitserver
356+
- increase replica count to 2
357+
- adjust resources limits and requests
358+
- pgsql
359+
- increase storage size to 500Gi
360360

361361
```yaml
362362
# instances/$INSTANCE_NAME/custom-resources/kustomization.yaml
@@ -454,8 +454,8 @@ components:
454454

455455
The component takes care of creating a new storage class named `sourcegraph` with the following configurations:
456456

457-
- Provisioner: pd.csi.storage.gke.io
458-
- SSD: types: pd-ssd
457+
- Provisioner: pd.csi.storage.gke.io
458+
- SSD: types: pd-ssd
459459

460460
It also updates the storage class name for all resources to `sourcegraph`.
461461

@@ -467,8 +467,8 @@ It also updates the storage class name for all resources to `sourcegraph`.
467467

468468
**Step 2**: Include one of the AWS storage class components in your overlay: [storage-class/aws/eks](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/eks) or [storage-class/aws/ebs](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/ebs)
469469

470-
- The [storage-class/aws/ebs-csi](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/eks) component is configured with the `ebs.csi.aws.com` storage class provisioner for clusters with self-managed Amazon EBS Container Storage Interface driver installed
471-
- The [storage-class/aws/aws-ebs](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/ebs) component is configured with the `kubernetes.io/aws-ebs` storage class provisioner for clusters with the [AWS EBS CSI driver installed as Amazon EKS add-on](https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html)
470+
- The [storage-class/aws/ebs-csi](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/eks) component is configured with the `ebs.csi.aws.com` storage class provisioner for clusters with self-managed Amazon EBS Container Storage Interface driver installed
471+
- The [storage-class/aws/aws-ebs](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph-k8s/-/tree/components/storage-class/aws/ebs) component is configured with the `kubernetes.io/aws-ebs` storage class provisioner for clusters with the [AWS EBS CSI driver installed as Amazon EKS add-on](https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html)
472472

473473
```yaml
474474
# instances/$INSTANCE_NAME/kustomization.yaml
@@ -497,10 +497,10 @@ components:
497497

498498
This component creates a new storage class named `sourcegraph` in your cluster with the following configurations:
499499

500-
- provisioner: disk.csi.azure.com
501-
- parameters.storageaccounttype: Premium_LRS
502-
- This configures SSDs and is highly recommended.
503-
- **A Premium VM is required.**
500+
- provisioner: disk.csi.azure.com
501+
- parameters.storageaccounttype: Premium_LRS
502+
- This configures SSDs and is highly recommended.
503+
- **A Premium VM is required.**
504504

505505
[Additional documentation](https://docs.microsoft.com/en-us/azure/aks/csi-storage-drivers) for more information.
506506

@@ -688,9 +688,9 @@ data:
688688

689689
**Step 3**: Configure the TLS settings of your Ingress by adding the following variables to your [buildConfig.yaml](/self-hosted/deploy/kubernetes/kustomize/#buildconfig-yaml) file:
690690

691-
- **TLS_HOST**: your domain name
692-
- **TLS_INGRESS_CLASS_NAME**: ingress class name required by your cluster-issuer
693-
- **TLS_CLUSTER_ISSUER**: name of the cluster-issuer
691+
- **TLS_HOST**: your domain name
692+
- **TLS_INGRESS_CLASS_NAME**: ingress class name required by your cluster-issuer
693+
- **TLS_CLUSTER_ISSUER**: name of the cluster-issuer
694694

695695
Example:
696696

@@ -878,33 +878,33 @@ Add a network rule that allows incoming traffic on port 30080 (HTTP) to at least
878878

879879
### Google Cloud Platform Firewall
880880

881-
- Expose the necessary ports.
881+
- Expose the necessary ports.
882882

883883
```bash
884884
$ gcloud compute --project=$PROJECT firewall-rules create sourcegraph-frontend-http --direction=INGRESS --priority=1000 --network=default --action=ALLOW --rules=tcp:30080
885885
```
886886

887-
- Include the nodeport component to change the type of the `sourcegraph-frontend` service from `ClusterIP` to `NodePort` with the `nodeport` component:
887+
- Include the nodeport component to change the type of the `sourcegraph-frontend` service from `ClusterIP` to `NodePort` with the `nodeport` component:
888888

889889
```yaml
890890
# instances/$INSTANCE_NAME/kustomization.yaml
891891
components:
892892
- ../../components/network/nodeport/30080
893893
```
894894

895-
- Directly applying this change to a running service [will fail](https://github.com/kubernetes/kubernetes/issues/42282). You must first delete the old service before redeploying a new one (with a few seconds of downtime):
895+
- Directly applying this change to a running service [will fail](https://github.com/kubernetes/kubernetes/issues/42282). You must first delete the old service before redeploying a new one (with a few seconds of downtime):
896896

897897
```bash
898898
$ kubectl delete svc sourcegraph-frontend
899899
```
900900

901-
- Find a node name.
901+
- Find a node name.
902902

903903
```bash
904904
$ kubectl get pods -l app=sourcegraph-frontend -o=custom-columns=NODE:.spec.nodeName
905905
```
906906

907-
- Get the EXTERNAL-IP address (will be ephemeral unless you [make it static](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address#promote_ephemeral_ip)).
907+
- Get the EXTERNAL-IP address (will be ephemeral unless you [make it static](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address#promote_ephemeral_ip)).
908908

909909
```bash
910910
$ kubectl get node $NODE -o wide
@@ -1079,15 +1079,15 @@ configMapGenerator:
10791079

10801080
Sourcegraph supports specifying an external Redis server with these environment variables:
10811081

1082-
- **REDIS_CACHE_ENDPOINT**=[redis-cache:6379](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24++REDIS_CACHE_ENDPOINT+AND+REDIS_STORE_ENDPOINT+-file:doc+file:internal&patternType=literal) for caching information.
1083-
- **REDIS_STORE_ENDPOINT**=[redis-store:6379](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24++REDIS_CACHE_ENDPOINT+AND+REDIS_STORE_ENDPOINT+-file:doc+file:internal&patternType=literal) for storing information (session data and job queues).
1082+
- **REDIS_CACHE_ENDPOINT**=[redis-cache:6379](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24++REDIS_CACHE_ENDPOINT+AND+REDIS_STORE_ENDPOINT+-file:doc+file:internal&patternType=literal) for caching information.
1083+
- **REDIS_STORE_ENDPOINT**=[redis-store:6379](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/sourcegraph/sourcegraph%24++REDIS_CACHE_ENDPOINT+AND+REDIS_STORE_ENDPOINT+-file:doc+file:internal&patternType=literal) for storing information (session data and job queues).
10841084

10851085
When using an external Redis server, the corresponding environment variable must also be added to the following services:
10861086

1087-
- `sourcegraph-frontend`
1088-
- `gitserver`
1089-
- `searcher`
1090-
- `worker`
1087+
- `sourcegraph-frontend`
1088+
- `gitserver`
1089+
- `searcher`
1090+
- `worker`
10911091

10921092
**Step 1**: Include the `services/redis` component in your components:
10931093

0 commit comments

Comments
 (0)