> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Filter Metric Name

<Badge className="hny-badge-enterprise-addon" stroke>Ent+</Badge>

<Note>
  This feature is available as an add-on for the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/).
  Please contact your Honeycomb account team for details.
</Note>

## Metric Name Filter Processor

The Metric Name Filter processor can be used to include or exclude metrics based on their name.

## Supported Types

| Metrics | Logs | Traces |
| :------ | :--- | :----- |
| ✓       |      |        |

## Configuration Table

| Parameter     | Type      | Default   | Description                                                                                                                                                                  |
| :------------ | :-------- | :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action        | `enum`    | `exclude` | `exclude` or `include` metrics that match.                                                                                                                                   |
| match\_type   | `enum`    | `strict`  | Method for matching values. Strict matching requires that 'value' be an exact match. Regexp matching uses [re2](https://github.com/google/re2/wiki/Syntax) to match a value. |
| metric\_names | `strings` | required  | One or more metric names to match on.                                                                                                                                        |

## Example Configuration

### Web Interface

<img src="https://mintcdn.com/honeycomb/ibXJI2unoLZRp0G4/_assets/images/htp/xnapper-filter-metric-name.png?fit=max&auto=format&n=ibXJI2unoLZRp0G4&q=85&s=54d7254455e6b92606092c502b7d8065" alt="Honeycomb Docs - Filter Metric Name - image 1" width="1950" height="1912" data-path="_assets/images/htp/xnapper-filter-metric-name.png" />

### Exclude Regexp

Filter out (exclude) metrics that match the expression `k8s.node.*`.

```yaml theme={}
apiVersion: bindplane.observiq.com/v1
kind: Processor
metadata:
  id: filter-name-regexp
  name: filter-name-regexp
spec:
  type: filter_metric_name
  parameters:
    - name: action
      value: exclude
    - name: match_type
      value: regexp
    - name: metric_names
      value:
        - k8s.node.*
```

### Include Strict

Include metrics that match, drop all other metrics.

```yaml theme={}
apiVersion: bindplane.observiq.com/v1
kind: Processor
metadata:
  id: include-name-strict
  name: include-name-strict
spec:
  type: filter_metric_name
  parameters:
    - name: action
      value: include
    - name: match_type
      value: strict
    - name: metric_names
      value:
        - k8s.container.cpu
        - k8s.pod.memory
```
