Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCU-2421: Adds monitoring overview page #4361

Merged
merged 5 commits into from
Aug 31, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions src/gateway/production/monitoring/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
---
title: Monitoring Overview

content-type: reference
---

## PLACEHOLDER Monitoring Overview
API gateways isolate your applications from the outside world and provide critical path
protection for your upstream services. Understanding the state of your API gateway
system is critical to providing reliable API-based systems.

There are many monitoring and alerting systems available, and {{site.base_gateway}} integrates with
multiple solutions:

* [Prometheus](https://prometheus.io/) is an open-source systems monitoring and alerting toolkit.
Prometheus provides a multi-demensional time series data model and query language.
The [Monitoring with Prometheus](/gateway/latest/production/monitoring/prometheus/) guide
shows how to install and configure the {{site.base_gateway}} [Prometheus plugin](/hub/kong-inc/prometheus/).
* [Datadog](https://www.datadoghq.com/) is a popular cloud based infrastructure and application monitoring service.
See the [Collect Metrics with Datadog guide](/gateway/latest/production/monitoring/datadog/) for information on
integrating {{site.base_gateway}} with Datadog. You can also integrate the [Datadog plugin](/hub/kong-inc/datadog/) with {{site.base_gateway}} for additional insights.
* [StatsD](https://github.com/statsd/statsd) is a lightweight network daemon that listens for application metrics on
UDP or TCP and sends aggregated values to one or more backend services. {{site.base_gateway}} directly supports StatsD
with the [StatsD plugin](/hub/kong-inc/statsd/). [Monitoring with StatsD](/gateway/latest/production/monitoring/statsd/) provides a
step-by-step guide to enabling StatsD.

Closely related to monitoring is tracing. See the {{site.base_gateway}} [Tracing Reference](/gateway/latest/production/tracing/)
for details about instrumenting your API gateway.