github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/metrics/blacklist.md (about) 1 --- 2 title: blacklist 3 type: metrics 4 status: deprecated 5 --- 6 7 <!-- 8 THIS FILE IS AUTOGENERATED! 9 10 To make changes please edit the contents of: 11 lib/metrics/blacklist.go 12 --> 13 14 import Tabs from '@theme/Tabs'; 15 import TabItem from '@theme/TabItem'; 16 17 :::warning DEPRECATED 18 This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives). 19 ::: 20 21 Blacklist metric paths within Benthos so that they are not aggregated by a child 22 metric target. 23 24 ```yaml 25 # Config fields, showing default values 26 metrics: 27 blacklist: 28 paths: [] 29 patterns: [] 30 child: {} 31 ``` 32 33 Blacklists can either be path prefixes or regular expression patterns, if either 34 a path prefix or regular expression matches a metric path it will be excluded. 35 36 Metrics must be matched using dot notation even if the chosen output uses a 37 different form. For example, the path would be 'foo.bar' rather than 'foo_bar' 38 even when sending metrics to Prometheus. A full list of metrics paths that 39 Benthos registers can be found in 40 [this list](/docs/components/metrics/about#paths). 41 42 ## Fields 43 44 ### `paths` 45 46 A list of path prefixes to exclude. This can be used, for example, to allow none of the child specific metrics paths from an output broker with the path `output.broker`. 47 48 49 Type: `array` 50 Default: `[]` 51 52 ### `patterns` 53 54 A list of RE2 regular expressions to exclude. This can be used, for example, to allow none of the latency based metrics with the pattern `.*\.latency`. 55 56 57 Type: `array` 58 Default: `[]` 59 60 ### `child` 61 62 A child metric type, this is where non-blacklisted metrics will be routed. 63 64 65 Type: `metrics` 66 Default: `{}` 67 68 ## Debugging 69 70 In order to see logs breaking down which metrics are registered and whether they 71 are blocked by your blacklists enable logging at the TRACE level. 72