> For the complete documentation index, see [llms.txt](https://docs.bindplane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bindplane.com/integrations/processors/filter-metric-name.md).

# Filter Metric Name

### 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

<table><thead><tr><th width="133.94140625">Parameter</th><th width="119.609375">Type</th><th width="116.0703125">Default</th><th>Description</th></tr></thead><tbody><tr><td>action</td><td><code>enum</code></td><td><code>exclude</code></td><td><code>exclude</code> or <code>include</code> metrics that match.</td></tr><tr><td>match_type</td><td><code>enum</code></td><td><code>strict</code></td><td>Method for matching values. Strict matching requires that 'value' be an exact match. Regexp matching uses <a href="https://github.com/google/re2/wiki/Syntax">re2</a> to match a value.</td></tr><tr><td>metric_names</td><td><code>strings</code></td><td>required</td><td>One or more metric names to match on.</td></tr></tbody></table>

### Example Configuration

#### Web Interface

<figure><img src="/files/OxXUkdDsbMVfZSkxrqAX" alt="Bindplane docs - Filter Metric Name - image 1"><figcaption></figcaption></figure>

#### Exclude Regexp

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

```yaml
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
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
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bindplane.com/integrations/processors/filter-metric-name.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.