Txlog Agent Documentation

Welcome to the documentation for the Txlog Agent. This agent compiles transactional data from your RPM-based system and sends it to a central server for monitoring and analytics.

📚 Documentation Structure

The documentation is organized into four sections:

1. Tutorials

Learning-oriented lessons for beginners.

• Getting Started: A hands-on guide to installing, configuring, and running the agent for the first time.

2. How-to Guides

Task-oriented guides for specific goals.

• Configure Authentication: Set up API Keys or Basic Auth.
• Verify Data Integrity: Ensure local and server data match.
• Run in CI/CD: Use the agent in automated pipelines with NO_COLOR.
• Secure Configuration: Protect your credentials.

3. Reference

Information-oriented technical descriptions.

• CLI Commands: build, verify, version.
• Configuration: txlog.yaml parameters.
• Environment Variables: NO_COLOR and others.

4. Explanation

Understanding-oriented background knowledge.

• Architecture Overview: How the system works.
• Data Synchronization: The logic behind the sync process.
• Design Choices: Why we chose Go, Cobra, and Regex.

Quick Links

• Project Repository: github.com/txlog/agent
• Issue Tracker: github.com/txlog/agent/issues