> For the complete documentation index, see [llms.txt](https://docs.vectra.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vectra.ai/deployment/stream/metadata-filtering-and-publishing.md).

# Metadata filtering and publishing

How to configure options for metadata filtering and the destination publisher of your choice.

## Metadata Filtering Options

Some customers may choose to limit metadata types that are forwarded due to use case requirements or data lake / SIEM scalability issues. Additionally, IPs, Subnets, and Sensor UIDs can also be used as exclusion filters to limit sources of metadata that are forwarded. To enable these filters edit and save in the following areas:

* *Configuration → SETUP → Stream → Metadata Types*
* *Configuration → SETUP → Stream → Vectra Stream Metadata Filtering*

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-c552382c9003aca245d9e379719ac65a95e499ee%2Fmetadata-filtering-and-publishing-1.png?alt=media)

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-428752412505d1c79aefa454aa05085ff6ed65bb%2Fmetadata-filtering-and-publishing-2.png?alt=media)

## Destination Publisher Configuration

Stream supports Syslog (over TCP), Elastic, Raw JSON, and Kafka publishers. To configure your publisher choice, edit the *Configuration → SETUP → Stream → Destination* area. The various publisher types have differing options. The example below shows the syslog over TCP configuration:

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-a21394b7fa1434b9238bf721c44e33e2d05ca349%2Fmetadata-filtering-and-publishing-3.png?alt=media)

Syslog and Kafka support the SSL protocol for secure connectivity from the Vectra Stream VM to your data lake. If SSL is selected, you will have to provide the client certificate, client key and server CA certificate.

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-c7ce2eeed3bcc28e52152a0e395c8c6c70b609c7%2Fmetadata-filtering-and-publishing-4.png?alt=media)

## Enabling Forwarding, Stream Status, and Metadata Statistics

To enable Metadata forwarding once the configuration of your chosen publisher is completed, turn on forwarding in the *Configuration → SETUP → Stream → Vectra Stream Metadata Forwarding* area and save.

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-45b5c5b86238baf728144595be150f0fade4c5c5%2Fmetadata-filtering-and-publishing-5.png?alt=media)

Health status of Stream can be seen at the bottom of the *Configuration → SETUP → Stream* page:

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-bfe3d66e47cbd236372d8a8c54ba174c79aee186%2Fmetadata-filtering-and-publishing-6.png?alt=media)

A summary of Stream health is also available in the System Health Dashboard at *Health → SYSTEM OVERVIEW → System Health* (*Discover → PLATFORM → System Health* in QUX 9.14 and earlier).

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-b25e2ed37b7e98c1b9c6b6f1358eb3c6ab000f23%2Fmetadata-filtering-and-publishing-7.png?alt=media)

Stream metadata statistics are available at *Health → NETWORK STATS → Stream Metadata* (*Network Stats → Stream Metadata* in QUX 9.14 and earlier).

![](https://4227135129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHJ1ltuWFvsArFWtevnRn%2Fuploads%2Fgit-blob-651b01ceb888bd1ec5eb4381cec0fb108a65261a%2Fmetadata-filtering-and-publishing-8.png?alt=media)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.vectra.ai/deployment/stream/metadata-filtering-and-publishing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
