Introduction
The Logs Tile offers powerful log filtering, visualization, and analysis capabilities. This feature enhances observability by allowing you to efficiently explore and analyze log data directly within your dashboards.
With Logs Tile, you can seamlessly monitor system events, detect anomalies, and gain deeper insights into application performance. Its grouping functionality allows you to categorize logs by key attributes, while bar chart visualizations simplify analysis, making it easier to detect patterns and correlations over time.
Key Features
- LogsQL Query Support: Construct custom queries to refine log data, focusing on specific information relevant to your analysis.
- Group By Functionality: Organize logs based on specific attributes, facilitating the identification of patterns and trends.
- Bar Visualization: Represent log data graphically using bar charts, providing clear and insightful visual summaries.
- Enhanced Log Analysis: Improve visibility into log data, allowing for more efficient troubleshooting and monitoring directly within dashboards.
- Advanced Filtering Options: Apply multiple filters such as time range, log severity, and source type to quickly pinpoint critical data.
- Customizable Views: Tailor log displays to show the most relevant information based on team or operational needs.
- Drill-Down Capabilities: Click into log entries for detailed insights, helping teams investigate issues more efficiently.
Note
The Logs tile feature is available only at client level.Prerequisites
- Logs must be available.
- Enable Logs Management at the client level.
Permissions
Following are the permissions required to Create and Manage Logs Tile:
Task | Permission Type | Permission Value |
---|---|---|
Create and Manage Logs Tile | Dashboards | Manage |
Logs | View |
Create a Logs Tile
To select your client, click the Client/Partner dropdown menu.
Note: You may either type your client’s name in the search bar or select your client from the list.From DASHBOARDS menu click Dashboard.
Create a new dashboard or select from an existing dashboard collection.
See Create Dashboards to learn about creating dashboards.
Click CREATE TILE or + from the toolbar.
In the ADD TILE screen that appears, select Logs.
Build my own
- Select the Build my own tile. This enables you to create a custom tile.
The ADD LOGS TILE window displays log information using a bar chart visualization by default, grouped by level.
You can filter logs using the LogsQL query support. - Click +FILTER and select the attribute, operator, and values from the drop-down lists to build the query.
- GROUP BY: By default,
level
is selected as label.- To add a label, click “+.”
- To change a label, click in the dropdown and select the required label.
- You can add a maximum of two labels.
- GROUP BY: By default,
- Click CREATE. The logs tile is created and displayed on the dashboard.
Example query syntax:
Example query result:
Note
You cannot use theline
attribute for the first time. The line
attribute allows you to search all your logs across the entire log body. For performance purposes, you can use line
to search only after you have already added another filter to reduce the number of logs being searched.Visualization
Click the VISUALIZATION tab to customize the visualization further:
- TILE
Label Name Description HEADER Set a name, color, size, and alignment for the header. Background Color Select the background color.
Enable or disable the background color by clicking the toggle ON or OFF.
Note: By default the Background Color option is disabled.- DISPLAY
Label Name Description Orientation Select Horizontal or Vertical data representation using the respective icons.
Note: By default, the Vertical bar chart representation is selected.
Enable Log Management
Log management is a configurable feature at the client level. You can enable or disable log management from the OpsRamp portal. You can either enable log management while adding a new client or on an existing client.
Follow these steps to enable Log Management:
To select your client, click the Client/Partner dropdown menu.
Note: You may either type your client’s name in the search bar or select your client from the list.Navigate to Setup → Account. The Account Details screen is displayed.
Click the Clients tile. The CLIENTS LIST screen displays the list of clients.
Search for the client using the search option and click on client name.
Click SETTINGS located in the upper-right corner of the screen. The ACCOUNT SETTINGS screen is displayed.
Select ADD-ONS tab and select Log Management in ADD-ONS section.
Click SAVE.
FAQs
1. What types of logs are available in the Logs Tile?
The tile supports system logs, application logs, audit logs, event logs, and any logs ingested into OpsRamp.
2. When does the tile refresh automatically?
The Logs tile gets auto-refreshed only when the selected time interval is one hour or less. You have to manually auto refresh if the interval is greater than 1 hour.
3. Why is my Logs Tile empty?
Ensure that:
- The correct data source is selected.
- Logs are being ingested into OpsRamp.
- Filters are not overly restrictive.
- The time range includes relevant logs.
Troubleshooting Steps
The following steps will guide you through identifying and resolving common issues.
- If the Group By labels selected have more than 100 combinations, then you will get an error saying Refine search query…
Solution: Select the labels or query accordingly.
- Logs Tile configuration settings are not saving.
Solution: Ensure you have the necessary permissions to modify the tiles.