Skip to main content

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

IdentifierDescriptionExpected Parameters Keys and Types
start_serviceStarts the Vector service.
stop_serviceStops the Vector service.

Information

IdentifierDescriptionTypePropertiesDefault Value
enabled_solutionsSolution whose logs are processedLIST_OF_STRINGSCONFIGURATION, MANDATORY, NON_DEDUCTIBLE, WRITABLE
loki_endpointEndpoint where Loki listensSTRINGCONFIGURATION, MANDATORY, NON_DEDUCTIBLE, WRITABLE
loki_tokenToken to authenticate to LokiSTRINGCONFIGURATION, MANDATORY, NON_DEDUCTIBLE, WRITABLE
loki_userUser to authenticate to LokiSTRINGCONFIGURATION, MANDATORY, NON_DEDUCTIBLE, WRITABLE
versionInstalled versionSTRINGMETRIC, READ_ONLY

Logs

IdentifierDescriptionLocationFormat
json_alertsFunctional logs in JSON format/var/log/vector.logJSON

Tests

IdentifierDescriptionType
active_serviceChecks if Vector's service is running.OPERATIONAL
internet_accessChecks if host has Internet access, which is required to download the package and, eventually, connect to Loki.REQUIREMENT
present_commandChecks if Vector is present as a command.PRESENCE
process_runningChecks if Vector's process is running.OPERATIONAL
valid_configurationChecks if the generated Vector configuration is valid. It includes a healthcheck for the connection with Loki.OPERATIONAL

References