Observability

Last updated: 2 minutes read.

Observability is a key concept in modern software systems that enables teams to understand the internal state of their applications and infrastructure through external outputs. It encompasses three main pillars:

  • Metrics: quantitative measurements of system performance and behavior over time
  • Logs: detailed records of events and state changes within the system
  • Traces: end-to-end tracking of requests as they flow through distributed systems

This section will explore how Tyk supports and enhances observability capabilities, enabling you to gain valuable insights into your systems and applications.

Metrics

Tyk components have been instrumented to send metrics to StatsD and NewRelic servers. Instructions on their use are provided here.

Logs

Tyk components generate system logs that record significant activity, including warnings and errors. Tyk can send these logs to 3rd party tools including Graylog and Logstash. For details on how to configure system logs see here.

Distributed Tracing

Distributed tracing is a monitoring and diagnostic technique used in software systems to track and visualize the path of requests as they traverse multiple microservices or components. In the context of an API gateway, distributed tracing helps capture and analyze the journey of API requests across various services, providing valuable insights into performance bottlenecks, latency issues and the overall health of the system.

Historically Tyk has supported OpenTracing but now recommends the use of OpenTelemetry for distributed tracing.

Support for OpenTelemetry has been available since Tyk 5.2. If you have any comments and suggestions for this feature, please leave a comment on this community forum post.


Note

Support for OpenTracing is now deprecated and we recommend that users migrate to OpenTelemetry.