Skip to content

Latest commit

 

History

History
102 lines (69 loc) · 3.62 KB

README.md

File metadata and controls

102 lines (69 loc) · 3.62 KB
Raw

td-agent-barito-kubernetes

This repository contains the source files needed to make a Docker image that collects Docker container log files using td-agent and sends them to Barito.

This image is designed to be used as a daemonset in a Kubernetes cluster. Every new version will be pushed to Barito Docker Hub

Because there are additional configurations that have to be made, this image full functionality can only be realized when you install it using our helm chart.

Usage

Sign in to BaritoMarket and find your Application Group. Barito Application Group Secret and Produce URL will be displayed, make note of those details.

Install Helm Chart

  1. Add our helm chart repo
helm repo add barito https://baritolog.github.io/helm-charts
  1. Create a custom yaml containing helm chart values to specify app that you want its logs to be forwarded, example:
# myApps.yaml
cluster_name: my-prod-cluster
defaultAppOptions:
  applicationGroupSecret: abc
  produceUrl: https://barito-router.my-domain.com/produce_batch
apps:
  - name: my-app-1
    baritoAppName: My App 1
  - name: my-app-2
    baritoAppName: My App 2
  - name: my-app-3
    baritoAppName: My App 3
    applicationGroupSecret: xyz
    produceUrl: https://barito-router.other-domain.com/produce_batch

name is metadata name of your deployment

  1. Install using helm
helm install barito/td-agent-barito --name=td-agent-barito --values=myApps.yaml

Override rbac.create when installing: --set rbac.create=true if you are using RBAC authorization.

Notes

If not specified,

  • DaemonSet will have memory limits of 2 Gi and memory requests 1 Gi. Use --set resources.limits.memory=XX or --set resources.requests.memory=XX to override.

  • DaemonSet will have cpu limits of 2 and cpu requests 500m. Use --set resources.limits.cpu=XX or --set resources.requests.cpu=XX to override.

  • DaemonSet will have ephemeral-storage limits of 6 Gi and ephemeral-storage requests 4 Gi. Use --set resources.limits.ephemeral-storage=XX or --set resources.requests.ephemeral-storage=XX to override.

  • td-agent will has config parse @type none by default. Use --set useCRIFormat=true if the cluster use CRI-o Format.

Adding Client Trail Information to Logs

Overview

This release introduces client trail information to logs by allowing the addition of custom labels through the additionaLabels field in your configuration. These labels will appear as part of the log metadata under the client_trail section, making it easier to filter and analyze logs in Kibana.

How to Use

In your configuration, add the additionaLabels field with key-value pairs in hash form under your values.yml. For example:

additionalLabels:
  env: "staging"
  cloud_service_provider: "gcp"
Example Log Output

With the above configuration, your logs will contain additional metadata like this:

{
  "message": "Sample log message",
  "client_trail": {
    "env": "staging",
    "cloud_service_provider": "gcp"
  }
}

This enables you to filter logs on Kibana easily using:

client_trail.env: staging
client_trail.cloud_service_provider: gcp
Use Cases

Environment-based filtering: Easily distinguish logs from staging, production, or development environments. Dynamic labels: Add any other relevant information (e.g., service_name, region) for better log categorization.