[DOC] Adding missing metric-generator keys

docs/sources/tempo/configuration/_index.md

@@ -30,6 +30,9 @@
     - [Local storage recommendations](#local-storage-recommendations)
     - [Storage block configuration example](#storage-block-configuration-example)
   - [Memberlist](#memberlist)
+  - [Configuration blocks](#configuration-blocks)
+    - [Filter policy config](#filter-policy config)
+    - [WAL config](#wal-config)
   - [Overrides](#overrides)
     - [Ingestion limits](#ingestion-limits)
       - [Standard overrides](#standard-overrides)
@@ -326,6 +329,12 @@
             # `wait` value for this processor.
             [enable_messaging_system_latency_histogram: <bool> | default = false]
 
+            # Attributes that will be used to create a peer edge
+            # Attributes are searched in the order they are provided
+            # See: https://pkg.go.dev/go.opentelemetry.io/otel/semconv/v1.18.0
+            # Example: ["peer.service", "db.name", "db.system", "host.name"]
+            [peer_attributes: <list of string> | default = ["peer.service", "db.name", "db.system"] ]
+
             # Attribute Key to multiply span metrics
             [span_multiplier_key: <string> | default = ""]
 
@@ -335,7 +344,7 @@
         span_metrics:
 
             # Buckets for the latency histogram in seconds.
-            [histogram_buckets: <list of float> | default = 0.002, 0.004, 0.008, 0.016, 0.032, 0.064, 0.128, 0.256, 0.512, 1.02, 2.05, 4.10]
+            [histogram_buckets: <list of float> | default = 0.002, 0.004, 0.008, 0.016, 0.032, 0.064, 0.128, 0.256, 0.512, 1.024, 2.048, 4.096, 8.192, 16.384]
 
             # Configure intrinsic dimensions to add to the metrics. Intrinsic dimensions are taken
             # directly from the respective resource and span properties.
@@ -357,19 +366,35 @@
             # the metrics if present.
             [dimensions: <list of string>]
 
-            # Custom labeling of dimensions is possible via a list of maps consisting of
-            # "name" <string>, "source_labels" <list of string>, "join" <string>
-            # "name" appears in the metrics, "source_labels" are the actual
-            # attributes that will make up the value of the label and "join" is the
-            # separator if multiple source_labels are provided
-            [dimension_mappings: <list of map>]
+            # Custom labeling mapping
+            dimension_mappings: <list of label mappings>
+                # The new label name
+              - [name: <string>]
+                # The actual attributes that will make the value of the new label
+                [source_labels: <list of strings>]
+                # The separator used to join multiple `source_labels`
+                [join: <string>]
+
             # Enable traces_target_info metrics
-            [enable_target_info: <bool>]
-            # Drop specific labels from traces_target_info metrics
-            [target_info_excluded_dimensions: <list of string>]
+            [enable_target_info: <bool> | default = false]
+
             # Attribute Key to multiply span metrics
             [span_multiplier_key: <string> | default = ""]
 
+            # Subprocessor toggles for metrics categories that exist under the umbrella of span metrics
+            subprocessors:
+              # Toggle the `Latency` metric category
+              [ 0: <bool> | default = true ]
+              # Toggle the `Count` metric category
+              [ 1: <bool> | default = true ]
+              # Toggle the `Size` metric category
+              [ 2: <bool> | default = true ]
+
+            # List of policies that will be applied to spans for inclusion or exclusion.
+            [filter_policies: <list of filter policies config> | default = []]
+
+            # Drop specific labels from `traces_target_info` metrics
+            [target_info_excluded_dimensions: <list of string>]
 
     # Registry configuration
     registry:
@@ -390,14 +415,23 @@
         # The maximum length of label values. Label values exceeding this limit will be truncated.
         [max_label_value_length: <int> | default = 2048]
 
+    # Configuration block for the Write Ahead Log (WAL)
+    traces_storage: <WAL Config>
+
+      # Path to store the WAL files.
+      # Must be set.
+      # Example: "/var/tempo/generator/traces"
+      [path: <string> | default = ""]
+
     # Storage and remote write configuration
     storage:
 
         # Path to store the WAL. Each tenant will be stored in its own subdirectory.
         path: <string>
 
         # Configuration for the Prometheus Agent WAL
-        wal:
+        # https://github.com/prometheus/prometheus/v2.51.2/tsdb/agent/db.go#L62-L84
+        wal: <prometeus agent WAL config>
 
         # How long to wait when flushing samples on shutdown
         [remote_write_flush_deadline: <duration> | default = 1m]
@@ -414,6 +448,12 @@
     # considered in metrics generation.
     # This is to filter out spans that are outdated.
     [metrics_ingestion_time_range_slack: <duration> | default = 30s]
+
+    # Timeout for generator requests (???)
+    [query_timeout: <duration> | default = 30s ]
+
+    # Overides the key used to register the metrics-generator in the ring.
+    [override_ring_key: <string> | default = "metrics-generator"]
 ```
 
 ## Query-frontend
@@ -1064,37 +1104,18 @@
         # the worker pool is used primarily when finding traces by id, but is also used by other
         pool:
 
-            # total number of workers pulling jobs from the queue (default: 400)
-            [max_workers: <int>]
+            # total number of workers pulling jobs from the queue
+            [max_workers: <int> | default = 30]
 
             # length of job queue. imporatant for querier as it queues a job for every block it has to search
-            # (default: 20000)
-            [queue_depth: <int>]
+            [queue_depth: <int> | default = 10000 ]
 
         # Configuration block for the Write Ahead Log (WAL)
-        wal:
-
-            # where to store the head blocks while they are being appended to
-            # Example: "wal: /var/tempo/wal"
-            [path: <string>]
-
-            # wal encoding/compression.
-            # options: none, gzip, lz4-64k, lz4-256k, lz4-1M, lz4, snappy, zstd, s2
-            [v2_encoding: <string> | default = snappy]
-
-            # Defines the search data encoding/compression protocol.
-            # Options: none, gzip, lz4-64k, lz4-256k, lz4-1M, lz4, snappy, zstd, s2
-            [search_encoding: <string> | default = none]
-
-            # When a span is written to the WAL it adjusts the start and end times of the block it is written to.
-            # This block start and end time range is then used when choosing blocks for search.
-            # This is also used for querying traces by ID when the start and end parameters are specified. To prevent spans too far
-            # in the past or future from impacting the block start and end times we use this configuration option.
-            # This option only allows spans that occur within the configured duration to adjust the block start and
-            # end times.
-            # This can result in trace not being found if the trace falls outside the slack configuration value as the
-            # start and end times of the block will not be updated in this case.
-            [ingestion_time_range_slack: <duration> | default = 2m]
+        wal: <WAL Config>
+          [path: <string> | default = "/var/tempo/wal"]
+          [v2_encoding: <string> | default = snappy]
+          [search_encoding: <string> | default = none]
+          [ingestion_time_range_slack: <duration> | default = 2m]
 
         # block configuration
         block:
@@ -1207,9 +1228,9 @@
     # Timeout for leaving memberlist cluster.
     [leave_timeout: <duration> | default = 5s]
 
-    # IP address to listen on for gossip messages. Multiple addresses may be
-    # specified. Defaults to 0.0.0.0
-    [bind_addr: <list of string> | default = ]
+    # IP address to listen on for gossip messages.
+    # Multiple addresses may be specified.
+    [bind_addr: <list of string> | default = ["0.0.0.0"] ]
 
     # Port to listen on for gossip messages.
     [bind_port: <int> | default = 7946]
@@ -1222,6 +1243,100 @@
 
 ```
 
+## Configuration blocks
+
+Defines re-used configuration blocks.
+
+### Filter policy config
+
+Span filter config block
+
+#### Filter policy
+```yaml
+# Exclude filters (postive matching)
+[include: <policy match>]
+
+# Exclude filters (negative matching)
+[exclude: <policy match>]
+```
+
+#### Policy match
+```yaml
+# How to match the value of attributes
+# Options: "strict", "regex"
+[match_type: <string>]
+
+# List of attributes to match
+attributes: <list of policy atributes>
+
+    # Attribute key
+  - [key: <string>]
+
+    # Attribute value
+    [value: <any>]
+```
+
+#### Examples
+
+```yaml
+exclude:
+  match_type: "regex"
+  attributes:
+    - key: "resource.service.name"
+      value: "unknown_service:myservice"
+```
+
+```yaml
+include:
+  match_type: "strict"
+  attributes:
+    - key: "foo.bar"
+      value: "baz"
+```
+
+### WAL config
+
+The storage WAL configuration block.
+
+```yaml
+# Where to store the wal files while they are being appended to.
+# Must be set.
+# Example: "/var/tempo/wal
+[path: <string> | default = ""]
+
+# Where to store the completed wal files
+# If not set (""), will join the `path` with "completed" to generate the effective path
+# Example: "/var/tempo/wal/completed"
+[completedfilepath: <string> | default = join(.path, "/completed")]
+
+# Where to store the intermediate blocks while they are being appended to.
+# Will always join the `path` with "blocks" to generate the effective path
+# Example: "/var/tempo/wal/blocks" (ignored)
+[blocksfilepath: <ignored> | = join(.path, "/blocks")]
+
+# WAL encoding/compression.
+# options: none, gzip, lz4-64k, lz4-256k, lz4-1M, lz4, snappy, zstd, s2
+[v2_encoding: <string> | default = "zstd" ]
+
+# Defines the search data encoding/compression protocol.
+# Options: none, gzip, lz4-64k, lz4-256k, lz4-1M, lz4, snappy, zstd, s2
+[search_encoding: <string> | default = "snappy"]
+
+# When a span is written to the WAL it adjusts the start and end times of the block it is written to.
+# This block start and end time range is then used when choosing blocks for search.
+# This is also used for querying traces by ID when the start and end parameters are specified. To prevent spans too far
+# in the past or future from impacting the block start and end times we use this configuration option.
+# This option only allows spans that occur within the configured duration to adjust the block start and
+# end times.
+# This can result in trace not being found if the trace falls outside the slack configuration value as the
+# start and end times of the block will not be updated in this case.
+[ingestion_time_range_slack: <duration> | default = unset]
+
+# WAL file format version
+# Options: v2, vParquet, vParquet2, vParquet3
+[version: <string> | default = "vParquet3"]
+```
+
 ## Overrides
 
 Tempo provides an overrides module for users to set global or per-tenant override settings.