jaeger-logzio

Jaeger-Logz.io

Jaeger-Logz.io is a storage option for Jaeger. It allows Jaeger to store distributed traces on your Logz.io account.

⚠️ Warning

We do not reccomend to use this library as standalone integration for traces, if you want to send traces to logz.io we reccomand using the opentelemetry collector contrib project with logzio exprter

Note: This integration requires Logz.io API access. The Logz.io API is available for Pro and Enterprise accounts.

Limitations

When you use the Jaeger UI to find traces stored in Logz.io, there are a couple limitations. For most users, these won't be an issue, but they're still good to know:

• Lookback must be 48 hours or less
• Limit Results must be 4000 traces or less

docker network create net-logzio

docker run -d \
 -e ACCOUNT_TOKEN=<<SHIPPING-TOKEN>> \
 -e API_TOKEN=<<API-TOKEN>> \
 --name=jaeger-logzio \
 --network=net-logzio \
 -p 5775:5775/udp \
 -p 6831:6831/udp \
 -p 6832:6832/udp \
 -p 5778:5778 \
 -p 16686:16686 \
 -p 14268:14268 \
 -p 9411:9411 \
logzio/jaeger-logzio:latest

docker network create net-logzio

docker run -e ACCOUNT_TOKEN=<<SHIPPING-TOKEN>> \
 --network=net-logzio \
 --name=jaeger-logzio-collector \
 -p 14268:14268 \
 -p 9411:9411 \
 -p 14269:14269 \
 -p 14250:14250 \
logzio/jaeger-logzio-collector:latest

docker run --rm -e API_TOKEN=<<API-TOKEN>> \
 --network=net-logzio \
 -p 16686:16686 \
 -p 16687:16687 \
 --name=jaeger-logzio-query \
logzio/jaeger-logzio-query:latest

docker run --rm --name=jaeger-agent --network=net-logzio \
 -p5775:5775/udp \
 -p6831:6831/udp \
 -p6832:6832/udp \
 -p5778:5778/tcp \
 jaegertracing/jaeger-agent:1.18.0 \
 --reporter.grpc.host-port=jaeger-logzio-collector:14250

Customizing shipping & API URLs

When you use the REGION environment variables, your listener URL and API URL are automatically set. For dev & testing purposes, you can override region settings by using these environment variables.

Customizing storage

By default, the queue is saved on disk You can also specify a custom directory to store the queue in

You can configure Jaeger-Logz.io the save the queue in memory and set log count limit and queue capacity:

Data compression

All bulks are compressed with gzip by default, to disable compressing initialize COMPRESS env variable set to false

Run go binary with bash

Clone this repo and change config.yaml to fit your Logz.io account parameters. Example:

region: "us"
apiToken: "api-token"
accountToken: "sapmle-token"
drainInterval: 5
customListenerUrl: "http://custom.com"
compress: true
inMemoryQueue: true
inMemoryCapacity: 20 * 1024 * 1024
logCountLimit: 10000

Then, build Logz.io binary:

go build

Clone and build jaeger all in one binary:

Follow the Getting Started from the Jaeger's repo. Build the Jaeger all-in-one binary or download it from the Jaeger releases page:

NOTE: If you intend to run the generated binary file from the build on a unix base system, set this env variable first:export GOOS=linux

go build -tags ui

Run Jaeger all-in-one binary with Logz.io storage:

SPAN_STORAGE_TYPE=grpc-plugin  ./cmd/all-in-one/all-in-one --grpc-storage-plugin.binary ~/path/to/jaeger-logzio/jaeger-logzio  --grpc-storage-plugin.configuration-file ~/path/to/jaeger-logzio/config.yaml

Example

HotROD (Rides on Demand) is a demo application by Jaeger that consists of several microservices and illustrates the use of the OpenTracing API. It can be run standalone, but requires Jaeger backend to view the traces. You can try and run to view sample traces:

docker run --rm -it \
  -p8080-8083:8080-8083  --network=net-logzio  \
  -e JAEGER_AGENT_HOST="jaeger-logzio" \
  jaegertracing/example-hotrod:1.9 \
  all

Note: if you're not running the all-in-one container, you should replace "jaeger-logzio" with the name of the host/container which runs the collector.

Then navigate to http://localhost:8080 .

Changelog

• v1.0.6

  • Update logzio-go (v1.0.5 -> v1.0.6)

• v1.0.5

  • Update logzio-go (v1.0.3 -> v1.0.5)
  • Fix region code bug

• v1.0.4

  • Logzio-go -> 1.0.3

• v1.0.3

  • Support for in memory queue
  • Added gzip compression

• v1.0.2

  • Changed the default queue directory from ~/tmp -> $HOME/tmp
  • Changed custom queue directory validation to be windows compatible

• v1.0.1

  • Support for custom queue directory

• v1.0.0 - Breaking Changes

  • Support for searching traces by tags is affected by the introduction of new tags.
  • Static image versions of Jaeger components (1.18)
  • Fix empty tags bug
    • Since the deprecation of TChannel in version 1.16, it is necessary to use gRPC reporter protocol when running a standalone Jaeger agent. - see "Run Jaeger agent"

• v0.0.3

  • Fix x509 certificate issue