This repository has been archived by the owner on Jun 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 📝 Install and operate docs changes
Signed-off-by: Prashant Shahi <prashant@signoz.io>
- Loading branch information
1 parent
eee5954
commit e46f682
Showing
9 changed files
with
207 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
id: configuration | ||
title: Configuration | ||
description: Learn how to configure SigNoz | ||
--- | ||
|
||
You can configure for SigNoz with different options. | ||
|
||
If no configuration for an option is set, then the default value as described is applied. | ||
|
||
## Environment variables | ||
|
||
When using SigNoz, there are various environment variables you can set to configure your SigNoz cluster. | ||
|
||
Here is a comprehensive list of all of them. However, for general use, you most likely do not have to worry about most of these. | ||
|
||
### Query Service | ||
|
||
<APITable> | ||
|
||
| Environment Variable | Description | Default Value | | ||
| -------- | ----------- | ------------- | | ||
| `STORAGE` | Database for the storage (one of `clickhouse` or `druid`(deprecated) | `clickhouse` | | ||
| `GODEBUG` | Go runtime name resolver (one of `netdns=go` or `netdns=cgo`). [More info](https://pkg.go.dev/net#hdr-Name_Resolution). | `netdns=go` | | ||
| `TELEMETRY_ENABLED` | Enable telemetry events collection. | `true` | | ||
| `ALERTMANAGER_API_PREFIX` | Endpoint of alertmanager with API prefix. | `http://alertmanager:9093/api/` | | ||
| `ClickHouseUrl`| ClickHouse database endpoint with TCP port | `tcp://localhost:9000` | | ||
|
||
</APITable> | ||
|
||
### Otel Collector | ||
|
||
Otel Collector supports multiple combination of options. | ||
Using the configuration file, you can pass `receivers`, `processors`, `extensions`, `exporters` and `service` as per your requirements. | ||
You can find the complete otel collector configuration in the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/configuration/). | ||
|
||
By default, SigNoz runs with [this default Otel Collector configuration](https://github.com/SigNoz/signoz/blob/main/deploy/docker/clickhouse-setup/otel-collector-config.yaml). | ||
|
||
For any configuration changes in **Docker**, you would have to update `/deploy/docker/clickhouse-setup/otel-collector-config.yaml` and bring up Otel Collector. | ||
|
||
### Otel Collector Metrics | ||
|
||
Otel Collector Metrics uses same image and binary as that of the Otel Collector. | ||
Hence, you will find the configuration similarities of that of [Otel Collector](/docs/operate/configuration#otel-collector). | ||
|
||
By default, SigNoz runs with [this default Otel Collector Metrics configuration](https://github.com/SigNoz/signoz/blob/main/deploy/docker/clickhouse-setup/otel-collector-metrics-config.yaml). | ||
For any configuration changes in **Docker**, you would have to update `/deploy/docker/clickhouse-setup/otel-collector-metrics-config.yaml` and bring up Otel Collector. | ||
|
||
|
||
## Kubernetes Configuration | ||
|
||
The latest helm chart configuration settings can be found: | ||
- https://github.com/signoz/charts/blob/main/charts/signoz/README.md#configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters