Skip to content

Commit

Permalink
Docs cleanup (#680)
Browse files Browse the repository at this point in the history
  • Loading branch information
yvrhdn authored Apr 30, 2021
1 parent 007c31d commit 6ccd6d8
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 11 deletions.
3 changes: 2 additions & 1 deletion RELEASES.MD
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ This document details release procedures for Tempo. Currently it's pretty dang
- Cull unnecessary changes that don't impact the Tempo binary or deployment
- Call out breaking changes!
- Submit a PR cleaning up the changelog and moving everything under "main/unreleased" to be under
the newly minted version.
the newly minted version.
- If any changes were made to the manifest, update [the docs as well](https://grafana.com/docs/tempo/latest/configuration/manifest/).
5 changes: 2 additions & 3 deletions docs/tempo/website/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ This section explains the configuration options for Tempo as well as the details
- [Authentication/Server](#authenticationserver)
- [Distributor](#distributor)
- [Ingester](#ingester)
- [Query Frontend](#queryfrontend)
- [Query Frontend](#query-frontend)
- [Querier](#querier)
- [Compactor](#compactor)
- [Storage](#storage)
- [Memberlist](#memberlist)
- [Compression](#compression)

## Authentication/Server
Tempo uses the Weaveworks/common server. See [here](https://github.com/weaveworks/common/blob/main/server/server.go#L45) for all configuration options.
Tempo uses the Weaveworks/common server. See [here](https://github.com/weaveworks/common/blob/master/server/server.go#L45) for all configuration options.

```
multitenancy_enabled: true # Optional. Require X-Scope-OrgID. By default, it's set to false.
Expand Down
12 changes: 7 additions & 5 deletions docs/tempo/website/configuration/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ Azure backend is configured in the storage block. Tempo requires a dedicated buc
```
storage:
trace:
backend: azure # store traces in azure
backend: azure # store traces in azure
azure:
container-name: tempo # store traces in this container.
endpoint-suffix: blob.core.windows.net # optional. Azure endpoint to use, defaults to Azure global(core.windows.net) for other regions this needs to be changed e.g Azure China(blob.core.chinacloudapi.cn), Azure German(blob.core.cloudapi.de), Azure US Government(blob.core.usgovcloudapi.net).
storage-account-name: "" # Name of the azure storage account
storage-account-key: "" # optional. access key when using access key credentials.
container-name: tempo # store traces in this container.
endpoint-suffix: blob.core.windows.net # optional. Azure endpoint to use, defaults to Azure global(core.windows.net) for other
# regions this needs to be changed e.g Azure China(blob.core.chinacloudapi.cn),
# Azure German(blob.core.cloudapi.de), Azure US Government(blob.core.usgovcloudapi.net).
storage-account-name: "" # Name of the azure storage account
storage-account-key: "" # optional. access key when using access key credentials.
```
2 changes: 1 addition & 1 deletion docs/tempo/website/configuration/compression.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ file an issue if you stumble upon any problems!
## WAL (Experimental)

The WAL also supports compression. By default this is turned off because it comes with a small performance penalty.
However, it does reduce disk i/o and add checksums to the WAL which are valuable in higher volume installations.
However, it does reduce disk i/o and adds checksums to the WAL which are valuable in higher volume installations.

```
storage:
Expand Down
13 changes: 12 additions & 1 deletion docs/tempo/website/configuration/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ go run ./cmd/tempo --storage.trace.backend=local --storage.trace.local.path=/tmp

```yaml
target: all
multitenancy_enabled: true
http_api_prefix: ""
server:
http_listen_address: ""
Expand Down Expand Up @@ -151,6 +150,7 @@ query_frontend:
max_body_size: 0
query_stats_enabled: false
max_outstanding_per_tenant: 100
querier_forget_delay: 0s
scheduler_address: ""
scheduler_dns_lookup_period: 0s
scheduler_worker_concurrency: 0
Expand Down Expand Up @@ -287,6 +287,7 @@ storage:
path: /tmp/tempo/wal
completedfilepath: /tmp/tempo/wal/completed
blocksfilepath: /tmp/tempo/wal/blocks
encoding: none
block:
index_downsample_bytes: 1048576
index_page_size_bytes: 256000
Expand Down Expand Up @@ -320,6 +321,9 @@ storage:
max-buffers: 4
buffer-size: 3145728
cache: ""
background_cache:
writeback_goroutines: 10
writeback_buffer: 10000
memcached: null
redis: null
overrides:
Expand Down Expand Up @@ -355,4 +359,11 @@ memberlist:
bind_port: 7946
packet_dial_timeout: 5s
packet_write_timeout: 5s
tls_enabled: false
tls_cert_path: ""
tls_key_path: ""
tls_ca_path: ""
tls_server_name: ""
tls_insecure_skip_verify: false

```
Empty file removed example/readme.md
Empty file.

0 comments on commit 6ccd6d8

Please sign in to comment.