Vector
Metadata
- Identifier:
vector
- Maturity: Production
Categories
- Log Shipper
Description
Vector is a lightweight tool for building observability pipelines. As soon as solutions are enabled in the configuration, Vector starts to send their logs to the configured Loki instance. The latter can be either on-premise or in the cloud, the only condition being to permit authentication via username and API token.
Actions
Identifier | Description | Expected Parameters Keys and Types |
---|---|---|
start_service | Starts the Vector service. | |
stop_service | Stops the Vector service. |
Information
Identifier | Description | Type | Properties | Default Value |
---|---|---|---|---|
enabled_solutions | Solution whose logs are processed | LIST_OF_STRINGS | CONFIGURATION , MANDATORY , NON_DEDUCTIBLE , WRITABLE | |
loki_endpoint | Endpoint where Loki listens | STRING | CONFIGURATION , MANDATORY , NON_DEDUCTIBLE , WRITABLE | |
loki_token | Token to authenticate to Loki | STRING | CONFIGURATION , MANDATORY , NON_DEDUCTIBLE , WRITABLE | |
loki_user | User to authenticate to Loki | STRING | CONFIGURATION , MANDATORY , NON_DEDUCTIBLE , WRITABLE | |
version | Installed version | STRING | METRIC , READ_ONLY |
Logs
Identifier | Description | Location | Format |
---|---|---|---|
json_alerts | Functional logs in JSON format | /var /log /vector.log | JSON |
Tests
Identifier | Description | Type |
---|---|---|
active_service | Checks if Vector's service is running. | OPERATIONAL |
internet_access | Checks if host has Internet access, which is required to download the package and, eventually, connect to Loki. | REQUIREMENT |
present_command | Checks if Vector is present as a command. | PRESENCE |
process_running | Checks if Vector's process is running. | OPERATIONAL |
valid_configuration | Checks if the generated Vector configuration is valid. It includes a healthcheck for the connection with Loki. | OPERATIONAL |