Metadata-Version: 2.1
Name: saltext.vector
Version: 0.0.4
Summary: Salt engine to send events to Vector
Home-page: https://gitlab.com/turtletraction/salt-grafana/
Author: Max Arnold
Author-email: max.arnold@turtletraction.com
License: Apache Software License
Project-URL: Source, https://gitlab.com/turtletraction/salt-grafana/
Project-URL: Tracker, https://gitlab.com/turtletraction/salt-grafana/issues
Keywords: salt-extension
Platform: any
Classifier: Programming Language :: Python
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# Salt Vector

[Salt](https://saltproject.io) engine to send events to [Vector](https://vector.dev)

## Quickstart

First, install Vector on the same (or separate) server as the Salt Master: https://vector.dev/docs/setup/installation/

The engine requires the following source to be configured in Vector:

```toml
[sources.salt_socket]
type = "socket"
address = "127.0.0.1:9000"  # change to 0.0.0.0:9000 if the server is separate from Salt
mode = "tcp"
max_length = 102400  # tweak to fit the largest event payload
decoding.codec = "json"
```

Second, install the engine on the Salt Master:

For onedir Salt package:

```shell
salt-pip install saltext.vector
```

For classic Salt package:

```shell
pip install saltext.vector
```

Third, place a snippet like this into `/etc/salt/master.d/engines.conf` and restart the master:

```yaml
engines:
  - vector:
      # host_id: myid  # master or minion id override, optional
      address: "127.0.0.1:9000"  # vector socket endpoing
      # include_tags:
      #   - "*"
      exclude_tags:
        - salt/auth
        - minion_start
        - minion/refresh/*
        - "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]"
```

To learn how to send events to Grafana and visualize the result, please visit the project documentation at https://turtletraction-oss.gitlab.io/salt-grafana/
