You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixing broken links and spelling
<!-- Explain the changes introduced in your PR -->
## Pull Request approval
You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Copy file name to clipboardExpand all lines: docs/admin/deploy/kubernetes/azure.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Sourcegraph with Kubernetes on Azure
2
2
3
3
> WARNING: This guide applies exclusively to a Kubernetes deployment **without** Helm.
4
-
> If you have not deployed Sourcegraph yet, it is higly recommended to use Helm as it simplifies the configuration and greatly simplifies the later upgrade process. See our guidance on [using Helm to deploy to Azure AKS](/admin/deploy/kubernetes#configure-sourcegraph-on-azure-managed-kubernetes-service-aks).
4
+
> If you have not deployed Sourcegraph yet, it is highly recommended to use Helm as it simplifies the configuration and greatly simplifies the later upgrade process. See our guidance on [using Helm to deploy to Azure AKS](/admin/deploy/kubernetes#configure-sourcegraph-on-azure-managed-kubernetes-service-aks).
5
5
6
6
Install the [Azure CLI tool](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) and log in:
7
7
@@ -63,5 +63,5 @@ az aks browse --resource-group sourcegraphResourceGroup --name sourcegraphCluste
63
63
Set up a load balancer to make the main web server accessible over the network to external users:
Copy file name to clipboardExpand all lines: docs/admin/deploy/kubernetes/configure.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1137,7 +1137,7 @@ Sourcegraph will clone repositories using SSH credentials when the `id_rsa` and
1137
1137
1138
1138
To mount the files through Kustomize:
1139
1139
1140
-
**Step 1:** Copy the required files to the `configs` folder at the same level as your overylay's kustomization.yaml file
1140
+
**Step 1:** Copy the required files to the `configs` folder at the same level as your overlay's kustomization.yaml file
1141
1141
1142
1142
**Step 2:** Include the following in your overlay to [generate secrets](https://kubernetes.io/docs/tasks/configmap-secret/managing-secret-using-kustomize/) that base64 encoded the values in those files
To reduce the volume of traces exported, the collector can be configured to apply sampling. Sourcegraph includes the [probabilistic](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/probabilisticsamplerprocessor) and [tail](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/tailsamplingprocessor/README) samplers in the bundled collector.
64
+
To reduce the volume of traces exported, the collector can be configured to apply sampling. Sourcegraph includes the [probabilistic](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/probabilisticsamplerprocessor) and [tail](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/tailsamplingprocessor/README.md) samplers in the bundled collector.
65
65
66
66
> NOTE: If sampling is enabled, the sampling mechanism will be applied to all traces, regardless if a request was explicitly requested to be traced.
67
67
@@ -90,7 +90,7 @@ service:
90
90
91
91
### Tail sampling
92
92
93
-
The tail sampler samples traces according to policies and the sampling decision of whether a trace should be sampled is determined at the _tail end_ of a pipeline. For more information on the supported policies and other configuration options of the sampler see [tail sampler configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/tailsamplingprocessor/README).
93
+
The tail sampler samples traces according to policies and the sampling decision of whether a trace should be sampled is determined at the _tail end_ of a pipeline. For more information on the supported policies and other configuration options of the sampler see [tail sampler configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/tailsamplingprocessor/README.md).
94
94
95
95
The sampler waits for a certain amount of spans before making applying the configured policy. Due to it keeping a certain amount of spans in memory, the sampler incurs as slight performance cost compared to the probabilistic sampler.
96
96
@@ -121,7 +121,7 @@ processors:
121
121
},
122
122
{
123
123
# Only keep 10% of the traces.
124
-
name: policy-probalistic,
124
+
name: policy-probabilistic,
125
125
type: probabilistic,
126
126
probabilistic: {sampling_percentage: 10}
127
127
}
@@ -136,7 +136,7 @@ service:
136
136
137
137
## Filtering traces
138
138
139
-
The bundled otel-collector also includes the [filter processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/filterprocessor/README). The following example only allows traces with the service name "foobar". All other traces will be dropped.
139
+
The bundled otel-collector also includes the [filter processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/filterprocessor/README.md). The following example only allows traces with the service name "foobar". All other traces will be dropped.
140
140
141
141
```yaml
142
142
exporters:
@@ -170,7 +170,7 @@ This section outlines some common exporter configurations. For details, see Open
170
170
171
171
### OTLP-compatible backends
172
172
173
-
Backends compatible with the [OpenTelemetry Protocol (OTLP)](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp) include services such as:
173
+
Backends compatible with the [OpenTelemetry Protocol (OTLP)](https://opentelemetry.io/docs/specs/otlp/) include services such as:
@@ -179,24 +179,24 @@ OTLP-compatible backends typically accept the [OTLP gRPC protocol](#otlp-grpc-ba
179
179
180
180
#### OTLP gRPC backends
181
181
182
-
Refer to the [otlp exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/otlpexporter/README) documentation for available options.
182
+
Refer to the [otlp exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/otlpexporter/README.md) documentation for available options.
183
183
184
184
```yaml
185
185
exporters:
186
186
otlp:
187
-
endpoint: otelcol2:4317
187
+
endpoint: secure-otel-collector:4317
188
188
tls:
189
189
cert_file: file.cert
190
190
key_file: file.key
191
191
otlp/2:
192
-
endpoint: otelcol2:4317
192
+
endpoint: insecure-otel-collector:4317
193
193
tls:
194
194
insecure: true
195
195
```
196
196
197
197
#### OTLP HTTP backends
198
198
199
-
Refer to the [otlphttp exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter/README) documentation for available options.
199
+
Refer to the [otlphttp exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter/README.md) documentation for available options.
200
200
201
201
```yaml
202
202
exporters:
@@ -208,7 +208,7 @@ exporters:
208
208
209
209
If you're looking for information about Sourcegraph's bundled Jaeger instance, head back to the [Tracing](/admin/observability/tracing) page to find the instructions for your deployment method.
210
210
211
-
Refer to the [jaeger exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/jaegerexporter/README) documentation for options.
211
+
Refer to the [Jaeger](https://opentelemetry.io/docs/languages/js/exporters/#jaeger) documentation for options.
212
212
213
213
If you must use your own Jaeger instance, and if the bundled otel-collector's basic configuration with the Jaeger OTel exporter enabled meets your needs, configure the otel-collector's startup command to `/bin/otelcol-sourcegraph --config=/etc/otel-collector/configs/jaeger.yaml`. Note that this requires the environment variable `$JAEGER_HOST` to be set on the otel-collector service / container:
214
214
@@ -220,14 +220,13 @@ exporters:
220
220
endpoint: "$JAEGER_HOST:14250"
221
221
tls:
222
222
insecure: true
223
-
224
-
# Deployment environment variables:
225
-
226
223
```
227
224
225
+
The Sourcegraph frontend automatically proxies Jaeger's web UI to make it available at `/-/debug/jaeger`. You can proxy your own Jaeger instance instead by configuring the `JAEGER_SERVER_URL` environment variable on the `frontend` containers, and the `QUERY_BASE_PATH='/-/debug/jaeger'` environment variable on your `jaeger` container.
226
+
228
227
### Google Cloud
229
228
230
-
If you run Sourcegraph in GCP and wish to export your HTTP traces to Google Cloud Trace, otel-collector can use project authentication. See the [googlecloud exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/googlecloudexporter/README) documentation for available options.
229
+
If you run Sourcegraph in GCP and wish to export your HTTP traces to Google Cloud Trace, otel-collector can use project authentication. See the [Google Cloud Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/googlecloudexporter/README.md) documentation for available options.
-`{{ .ExternalURL }}` is the value of the `externalURL` setting in your Sourcegraph instance's Site Configuration
44
44
-`{{ .TraceID }}` is the TraceID which gets generated while processing the request
45
45
46
-
Once deployed, the Jaeger web UI will be accessible at `/-/debug/jaeger`.
47
-
48
-
The Sourcegraph frontend automatically proxies Jaeger's web UI to make it available at `/-/debug/jaeger`. You can proxy your own Jaeger instance instead by configuring the `JAEGER_SERVER_URL` environment variable on the `frontend` containers, and the `QUERY_BASE_PATH='/-/debug/jaeger'` environment variable on your `jaeger` container.
46
+
Once deployed, the Jaeger web UI will be accessible at `/-/debug/jaeger`
49
47
50
48
### External OpenTelemetry-Compatible Platforms
51
49
52
50
If you prefer to use an external, OTel-compatible platform, you can configure Sourcegraph to export traces to it instead. See our [OpenTelemetry documentation](/admin/observability/opentelemetry) for further details.
53
51
54
-
Once your OTel backend is configured, configure the `urlTemplate` to link to your tracing backend.
2. Optionally, configure `observability.client`, for Sourcegraph clients to also report traces, ex. src cli
55
56
56
-
For example, if you [export your traces to Honeycomb](/admin/observability/opentelemetry#otlp-compatible-backends), your Site Configuration may look like:
57
+
For example, if you export your traces to [Honeycomb](/admin/observability/opentelemetry#otlp-compatible-backends), your Site Configuration may look like:
0 commit comments