Skip to main content

Grafana Plugin Tutorial

How to Use the Grafana Plugin in DevPortal​

The Grafana Plugin in DevPortal empowers you to monitor and visualize metrics, logs, and traces from your services. This tutorial will guide you through the steps to use it effectively, leveraging its observability features to enhance your system's performance and reliability.

Why Use the Grafana Plugin?​

  • Real-Time Visualization: Monitor system behavior with interactive dashboards.
  • Customization: Create tailored panels for specific needs.
  • Alerting: Set thresholds to receive notifications for potential issues.
  • User-Friendly Interface: Easy to set up and use within DevPortal.

Step-by-Step Guide

Step 1: Accessing DevPortal​

  1. Log in to DevPortal with your credentials.
  2. Gain access to all functionalities and plugins for your project.

Step 2: Navigating to the Catalog​

  1. In the sidebar menu, select the "Catalog" tab.
  2. Filter items by selecting "API" or "Component".
  3. Narrow your search to locate the desired item quickly.

Step 3: Selecting the Configured Item​

  1. Browse the list for an API or component with the Grafana plugin configured.
  2. Unsure about the setup? Contact VeeCode Platform support or review support plan options at platform.vee.codes.

Step 4: Accessing the Grafana Plugin​

  1. Open the selected API or component.
  2. In the "Overview" section of the configured plugins, locate the Grafana Plugin.
  3. Explore its pre-configured dashboards for initial insights.

Step 5: Interacting with Grafana​

Grafana offers diverse functionalities to monitor and analyze your system:

  • Metrics Monitoring: View response times, throughput, and error rates.
  • Log Analysis: Search and examine logs for errors, delays, or failures.
  • Tracing: Track request execution across services to pinpoint latency or errors.
  • Customization: Modify pre-configured panels or create new ones tailored to your needs.

The Grafana Plugin is a robust observability tool in DevPortal, simplifying system monitoring and troubleshooting. By following this guide, you can unlock valuable insights into your services' performance and stability.