juspay/hyperswitch

feat(logging): add support for reading locally generated file logs via vector instance

Open

#5,123 opened on Jun 26, 2024

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Rust (42,690 stars) (4,676 forks)batch import
A-infraC-featuregood first issue

Description

Currently we use a vector docker service to manage our logs & events pipeline. This vector is controlled by this configuration.

We need to add support for reading file logs from local system and send them to loki / opensearch with a proper tag/labels.

Can take a look at the promtail configuration to get an idea about the exact specifications of this.

References: file source in vector addition of vector service

Contributor guide

Tech stack
rustdocker
Domain
observabilitydevopsinfrastructure
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Vector configurationFamiliarity with Loki/OpenSearchBasic knowledge of Docker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the existing vector configuration at config/vector.yaml and the promtail configuration at config/promtail.yaml to understand the desired log source and labels. Review the reference PR #5021 that added the vector service. Then, implement a file source in Vector according to the Vector documentation, ensuring logs are properly tagged and sent to Loki/OpenSearch. The issue is assigned, so coordinate with the assignee before proceeding.