Google Apigee Metrics via Telegraf
Ship your Google Apigee Metrics via Telegraf to your Logit.io Stack
Configure Telegraf to ship Google Apigee metrics to your Logit.io stacks via Logstash.
Follow this step by step guide to get 'logs' from your system to Logit.io:
Step 1 - Set credentials in GCP
Apigee, a key feature of Google Cloud's suite, exemplifies a unique ensemble of tools designed specifically for API lifecycle management. This comprehensive platform is engineered to design, deploy, and oversee APIs, thereby promoting secure and streamlined communication between disparate software entities in a cloud-oriented environment.
- Begin by heading over to the 'Project Selector' and select the specific project from which you wish to send metrics.
- Progress to the 'Service Account Details' screen. Here, assign a distinct name to your service account and opt for 'Create and Continue'.
- In the 'Grant This Service Account Access to Project' screen, ensure the following roles: 'Compute Viewer', 'Monitoring Viewer', and 'Cloud Asset Viewer'.
- Upon completion of the above, click 'Done'.
- Now find and select your project in the 'Service Accounts for Project' list.
- Move to the 'KEYS' section.
- Navigate through Keys > Add Key > Create New Key, and specify 'JSON' as the key type.
- Lastly, click on 'Create', and make sure to save your new key.
Now add the environment variable for the key
On the machine run:
export GOOGLE_APPLICATION_CREDENTIALS=<your-gcp-key>
Step 2 - Install Telegraf
This integration allows you to configure a Telegraf agent to send your metrics, in multiple formats, to Logit.io.
Telegraf is a flexible server agent equipped with plug-in support, useful for sending metrics and events from data sources like web servers, APIs, application logs, and cloud services.
To ship your metrics to Logit.io, we will integrate the relevant input and outputs.http plug-in into your Telegraf configuration file.
Choose the install for your operating system below to get started:
Windows
wget https://dl.influxdata.com/telegraf/releases/telegraf-1.19.2_windows_amd64.zip
Download and extract to: C:\Program Files\Logitio\telegraf\
Configuration file: C:\Program Files\Logitio\telegraf\
MacOS
brew install telegraf
Configuration file x86_64 Intel: /usr/local/etc/telegraf.conf
Configuration file ARM (Apple Silicon): /opt/homebrew/etc/telegraf.conf
Ubuntu/Debian
wget -q https://repos.influxdata.com/influxdata-archive_compat.key
echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | sudo tee /etc/apt/sources.list.d/influxdata.list
sudo apt-get update
sudo apt-get install telegraf
Configuration file: /etc/telegraf/telegraf.conf
RedHat and CentOS
cat <<EOF | sudo tee /etc/yum.repos.d/influxdata.repo
[influxdata]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/\$basearch/main
enabled = 1
gpgcheck = 1
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
EOF
sudo yum install telegraf
Configuration file: /etc/telegraf/telegraf.conf
SLES & openSUSE
zypper ar -f obs://devel:languages:go/ go
zypper in telegraf
Configuration file: /etc/telegraf/telegraf.conf
FreeBSD/PC-BSD
sudo pkg install telegraf
Configuration file: /etc/telegraf/telegraf.conf
Step 3 - Configure the Telegraf input plugin
First you need to set up the input plug-in to enable Telegraf to scrape the GCP data from your hosts. This can be accomplished by incorporating the following code into your configuration file:
# Gather timeseries from Google Cloud Platform v3 monitoring API
[[inputs.stackdriver]]
## GCP Project
project = "<your-project-name>"
## Include timeseries that start with the given metric type.
metric_type_prefix_include = [
"apigee.googleapis.com",
]
## Most metrics are updated no more than once per minute; it is recommended
## to override the agent level interval with a value of 1m or greater.
interval = "1m"
Step 4 - Configure the output plugin
Once you have generated the configuration file, you need to set up the output plug-in to allow Telegraf to transmit your data to Logit.io in Prometheus format. This can be accomplished by incorporating the following code into your configuration file:
[[outputs.http]]
url = "https://<your-metrics-username>:<your-metrics-password>@<your-metrics-stack-id>-vm.logit.io:0/api/v1/write"
data_format = "prometheusremotewrite"
[outputs.http.headers]
Content-Type = "application/x-protobuf"
Content-Encoding = "snappy"
Step 5 - Start Telegraf
Windows
telegraf.exe --service start
MacOS
telegraf --config telegraf.conf
Linux
sudo service telegraf start
for systemd installations
systemctl start telegraf
Step 6 - View your metrics
Data should now have been sent to your Stack.
If you don't see metrics take a look at How to diagnose no data in Stack below for how to diagnose common issues.
Step 7 - How to diagnose no data in Stack
If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.
Step 8 - Telegraf Google Apigee metrics Overview
Telegraf, InfluxData's premier open-source server agent, is engineered for capturing metrics and data from a myriad of sources, including APIs and gateway platforms. Google Apigee is designed to help organizations design, secure, deploy, monitor, and scale APIs, playing a crucial role in digital transformation initiatives by enabling seamless connectivity between applications, data, and devices across cloud and on-premises environments.
The integration of Telegraf with Google Apigee empowers organizations to monitor their API performance, traffic, and health metrics in real time. This capability is vital for API developers and operations teams to ensure their APIs are performing optimally, remain secure, and provide the scalability necessary to handle varying loads. Metrics such as API call latencies, error rates, traffic volumes, and response times are crucial for diagnosing and resolving issues, optimizing API performance, and enhancing the overall user experience.
However, the vast amount of data generated from monitoring APIs can be challenging to manage, analyze, and visualize effectively. Logit.io offers a comprehensive solution to these challenges by providing a sophisticated platform that simplifies the processing and analysis of metrics from Telegraf and Google Apigee.
With Logit.io, businesses can enhance their API monitoring and analytics capabilities, enabling them to quickly identify and address performance bottlenecks, improve security postures, and ensure compliance with usage policies and regulations. The platform's advanced analytics and visualization tools support proactive management of API ecosystems, helping organizations to maintain high-quality, reliable API services that meet the demands of their users and applications.
For those utilizing Telegraf in conjunction with Google Apigee and looking to advance their API monitoring and analytics strategies, Logit.io provides the tools and support necessary. Whether you're looking to optimize performance, strengthen security, or gain a deeper understanding of your API usage, Logit.io's robust search and analytics tools have you covered. With this integration, you can easily uncover hidden trends and issues within your API traffic data, helping you make more informed decisions and take your API management to the next level. For effective data management and sharing, explore the capabilities of sending Google Firestore metrics next. To delve into the transformative world of Google Contact Center AI insights and metrics for exceptional customer service operations, check out our integration. Logit.io's GCP logging seamlessly integrates with various platforms.