Skip to main content
Skip table of contents

Grafana for the Support Team

Overview

Grafana is a monitoring and visualization tool that connects to data sources. It displays backend logs and performance metrics, such as CPU usage and response times. We can use it to diagnose issues, analyze system health and review backend logs. It also provides alerting to quickly address performance bottlenecks.


Grafana Access

We can log in using the “Sing in with Microsoft” button.

image-20250116-202001.png

Grafana Home page

Once you open the Grafana site it should display the window shown below. From this view, you can navigate through the various options in the menu located to the left of the "Home" label.

image-20250116-192126.png

To verify the Instance Status.

This Instance Status page in Grafana provides a real-time snapshot of the health and performance of both the application server and the SQL database server, and the status of Cognos and the application server.

image-20250730-163855.png

Server is up and running.

image-20250730-162702.png

Servers are down, returning 500 or 502 errors.

image-20250730-163415.png

To verify CPU Usage - Instance Health

  1. Click on the menu icon and select the option, “Dashboards”.

image-20250116-193413.png
  1. After clicking on Dashboards, look for the “Linux Hosts” option.

Infrastructure >> Metrics >> Linux Host.

image-20250116-193526.png
  1. Grafana will display a window with all graphs available for monitoring. We only need to set up the “Job” and the “Host”.

image-20250116-195036.png

Fields to configure to display the instance performance:

image-20250116-194831.png
  1. The "Job" field typically represents a label that identifies the source of the metrics being collected. It is used to group or distinguish metrics based on the specific service, process, or system component being monitored. For example, it might indicate a server name, application, or a specific monitoring task configured in the data source

  2. the "Host" field is used to filter metrics based on the specific server, machine, or instance being monitored. It allows you to narrow down the data displayed to a particular host within the selected "Job," providing more granular insights into system performance for that specific machine.

In W, the “Job” name refers to:

  • In Azure: The Subscription

  • In OpenMetal: Only OpenMetal

  • In AWS: The Account

E.g. Terra Job would be:

image-20250116-195208.png

The “Host” refers to the instance where the PROD/UAT/TEST/Project data is housed.

You can confirm the “Host” at https://wemanage.wenergysoftware.com/#/hosts. To confirm, simply check the Host Name displayed through the corresponding icon image-20250116-200122.png of the environment that you want to monitor.

image-20250116-200215.png

E.g.

The Production Hosts usually start with a “p”

  1. Once all the fields are configured, you should see all the monitoring metrics, such as CPU basics, Memory Usage %, Network Traffic basics, and more.

image-20250116-200720.png

In the window above, you can star this dashboard for quick access and adjust the monitoring timeframe as needed.


To verify Backend - Instance Logs

  1. Click on the menu icon and select the option, “Explore”.

image-20250116-220323.png
  1. Once in the explore window, search for “loki” as data source.

image-20250116-220742.png
  1. Set the filters for the query as shown below.

1- Select the filter, in this case, “Instance_name” which is the same “Host name”, you can copy and paste it in the filter.

2- Select the timeframe as needed.

3- Include the string or word that you want to seek in the logs. For example: “Error”

4- Verify what the logs will return.

5- Run the query.

image-20250116-221254.png

You can adjust the filters according to your needs, and in the “options” you can increase the number of lines to get from the query, it’s by default 1000 but you can increase it up to 5000.

  1. Once you run the query, Grafana will return the Logs lines that include the word “Error”.

In the below window, you will find a lot of information that can help you with your research.

For example:

  • The timeframe of occurrence.

  • line options as “Wrap Lines” or Prettify JSON responses.

  • Download the logs returned.

  • The word “Error” highlighted in every line.

image-20250116-222336.png

Some lines will provide you with a Trace ID or Span ID, which are identifiers for specific errors or occurrences. These IDs can be copied into the 'Text to find' filter to retrieve additional errors related to the same occurrence or event. Please refer to the example below

  1. Once you get the line or error that you are looking for, you can use the “trace_id” or “span_id” of that line to get more logs for the same error or event. For the example below, we copied and pasted the “trace_id” above and executed the query again.

image-20250116-223312.png

By following this process, you can retrieve all logs related to the specific 'trace_id,' providing more valuable backend information about the identified error.

image-20250116-223617.png
image-20250116-224043.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.