Parca data source supported versions
The Parca data source supports Parca v0.19 and later.
Grafana dashboards · all subjects
overview
262 notes in this subject, read out of this brain and free to use. This is page 2 of 5.
Parca is a continuous profiling database
Parca is a continuous profiling database for analysis of CPU and memory usage down to the line number and throughout time. Grafana ships with built-in support for Parca.
Parca data source workflow
To use Parca profiling data in Grafana, set up Parca to scrape profiles from your applications, configure the Parca data source in Grafana, then query profiling data using the query editor in Explore.
Parca data source supported features
The Parca data source supports Profiles and Metrics. Alerting and Annotations are not supported.
Explore is primary interface for Parca data
Explore is the primary way to interact with Parca data in Grafana. It allows querying profiles and metrics without building a dashboard, and selecting the Both query type to view flame graphs and time-series data side by side.
Parca data source deprecation date
Starting January 2, 2027, the Parca data source plugin is deprecated and will no longer receive updates after that date.
Parca profiling data in dashboards
Using the Parca data source, profiling data can be embedded in dashboards alongside other signals like logs and metrics. For example, a flame graph panel showing CPU profiles can be placed next to a metrics panel tracking request latency to correlate performance bottlenecks with application behavior.
PostgreSQL data source built-in to Grafana
Grafana includes a built-in PostgreSQL data source plugin that requires no installation. It enables querying and visualizing data from any PostgreSQL-compatible database.
PostgreSQL-compatible databases with wire protocol support
Several databases use the PostgreSQL wire protocol and may work with the PostgreSQL data source: TimescaleDB (enable the TimescaleDB toggle in data source settings for time_bucket support), CockroachDB, Amazon Redshift (also has a dedicated Redshift data source with additional features), CrateDB, and YugabyteDB.
PostgreSQL data source key capabilities
The PostgreSQL data source supports time series queries with built-in time grouping macros, table queries for any valid SQL query, EXPLAIN queries to inspect query execution plans, template variables for dynamic dashboards, annotations to overlay events on panels, alerting based on time series query results, and macros to simplify time filtering and grouping.
Supported PostgreSQL-compatible databases
The PostgreSQL data source supports PostgreSQL 9.0 and newer, Amazon RDS for PostgreSQL, Amazon Aurora PostgreSQL, Azure Database for PostgreSQL, and Google Cloud SQL for PostgreSQL. Grafana recommends using the latest available version for optimal compatibility.
Supported PostgreSQL data types
The PostgreSQL plugin uses the PGX driver and supports the following data types: numeric types (int2, int4, int8, float4, float8, numeric), string types (text, varchar, char, bpchar), date/time types (timestamp, timestamptz, date, time, timetz, interval), boolean (bool), JSON types (json, jsonb), enumerated types (custom enum types returned as strings), and other types not explicitly mapped (arrays, composites, custom domains) returned as string values.
Synthetic Monitoring API
The Grafana Cloud Synthetic Monitoring REST API provides programmatic access to Synthetic Monitoring resources.
Tempo Tracing API
Tempo exposes an API for pushing and querying traces, and operating the cluster itself.
Grafana Cloud API GCOM
The Grafana Cloud API, also known as the Grafana.com API or GCOM API, allows programmatic interaction with resources from a Grafana Cloud Stack.
Grafana HTTP API for resource management
The Grafana HTTP API is exposed by every Grafana instance and is used by the Grafana frontend to manage resources including saving dashboards, creating users, updating data sources, and deleting alerts. The HTTP API can be used to programmatically access or manage resources from a Grafana instance.
POST /api/admin/encryption/reencrypt-secrets re-encrypts secrets
The POST /api/admin/encryption/reencrypt-secrets endpoint re-encrypts secrets. Returns HTTP 204 with no content.
POST /api/admin/encryption/rotate-data-keys rotates encryption keys
The POST /api/admin/encryption/rotate-data-keys endpoint rotates the data encryption keys. Returns HTTP 204 with no content.
POST /api/admin/ldap/reload endpoint removed from Admin API
The POST /api/admin/ldap/reload endpoint has been removed from the Admin API starting with Grafana 12.4.0. LDAP configuration now automatically reloads from the database or .toml file through SSO settings. The endpoint returns HTTP 410 with message 'This endpoint has been removed. LDAP configuration is now loaded from SSO settings.'
GET /api/admin/users/:id/auth-tokens returns user's logged-in devices
The GET /api/admin/users/:id/auth-tokens endpoint returns a list of all auth tokens (devices) that the user identified by :id currently has logged in from. Each token object contains: id (token ID), isActive (boolean), clientIp (IP address), browser (browser name), browserVersion (version string), os (operating system), osVersion (version string), device (device type), createdAt (ISO timestamp), and seenAt (ISO timestamp).
DELETE /api/admin/users/:id deletes a global user
The DELETE /api/admin/users/:id endpoint deletes a global user identified by :id. Returns HTTP 200 with JSON message 'User deleted'.
PUT /api/admin/users/:id/permissions updates user permissions
The PUT /api/admin/users/:id/permissions endpoint updates permissions for a user identified by :id. Request body contains 'isGrafanaAdmin' boolean field to set or revoke Grafana server administrator status. Returns HTTP 200 with JSON message 'User permissions updated'.
PUT /api/admin/users/:id/password changes user password
The PUT /api/admin/users/:id/password endpoint changes the password for a specific user identified by :id. Request body contains 'password' field with new password string. Returns HTTP 200 with JSON message 'User password updated'.
POST /api/admin/users creates a new user
The POST /api/admin/users endpoint creates a new global user. Required request fields: name (string), email (string), login (string), password (string). Optional field: OrgId (integer) to assign the new user to a different organization when auto_assign_org is set to true. Returns HTTP 200 with JSON containing id (user ID) and message 'User created'.
GET /api/admin/usage-report-preview previews usage report
The GET /api/admin/usage-report-preview endpoint previews the usage report to be sent to vendor. Returns HTTP 200 with JSON containing 'version' (format: x_y_z) and 'metrics' object with usage statistics including stats.active_admins.count, stats.active_editors.count, stats.active_sessions.count, stats.active_users.count, stats.active_viewers.count, stats.admins.count, stats.alert_rules.count, stats.alerts.count, stats.annotations.count, stats.api_keys.count, and similar metrics.
GET /api/admin/stats returns Grafana statistics
The GET /api/admin/stats endpoint returns statistics about the Grafana instance. The response includes: users (number of users), orgs (number of organizations), dashboards (number of dashboards), snapshots (number of snapshots), tags (number of tags), datasources (number of data sources), playlists (number of playlists), stars (number of starred dashboards), alerts (number of alerts), and activeUsers (number of active users).
PUT /api/admin/settings updates database settings (Enterprise v8.0+)
The PUT /api/admin/settings endpoint updates, removes, or reloads database settings. Available in Grafana Enterprise v8.0+. You must provide either 'updates', 'removals', or both fields. This endpoint only supports changes to auth.saml configuration. Request body contains 'updates' and 'removals' objects. Returns HTTP 200 with message 'Settings updated'. Possible status codes: 200 OK, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error.
GET /api/admin/settings endpoint fetches Grafana settings
The GET /api/admin/settings endpoint returns all Grafana configuration settings including DEFAULT, analytics, auth.anonymous, auth.basic, auth.github, auth.google, auth.ldap, auth.proxy, dashboards.json, database, emails, log, paths, security, server, session, smtp, and users configuration sections. Returns HTTP 200 with JSON response containing nested configuration objects.
Admin API authentication requires Basic auth and server admin permission
To use Admin API endpoints, you must authenticate with Basic authentication (username and password), and the Grafana user must have Grafana server administrator permission. Service account tokens cannot be used to authenticate to the Admin HTTP API because service accounts are limited to an organization and organization role, and cannot be granted Grafana server administrator permissions.
POST /api/admin/users/:id/logout revokes all auth tokens for a user
The POST /api/admin/users/:id/logout endpoint revokes all auth tokens (devices) for the user identified by :id. All users of issued auth tokens will no longer be logged in and will be required to authenticate again upon next activity. Returns HTTP 200 with JSON message 'User auth token revoked'.
POST /api/admin/encryption/rollback-secrets rolls back secrets
The POST /api/admin/encryption/rollback-secrets endpoint rolls back secrets to a previous encryption state. Returns HTTP 204 with no content.
Folder/Dashboard Search API endpoint
The Folder/Dashboard Search API is accessed via GET /api/search/. This endpoint returns folders and dashboards that match search criteria. When Role-based access control is enabled, search results will contain only dashboards and folders which the requester has access to.
Folder/Dashboard Search API deprecated
The Folder/Dashboard Search API is a legacy API and is deprecated in current versions of Grafana.
Folder/Dashboard Search API response fields
The GET /api/search/ endpoint returns an array of objects with the following fields: id (numeric dashboard or folder id), uid (unique identifier), orgId (organization id), title (folder or dashboard title), url (full URL path to the resource), type ('dash-folder' or 'dash-db'), tags (array of tags), isStarred (boolean indicating if starred), uri (deprecated in Grafana v5.0, do not use). For dashboards that are in a folder, the response additionally includes: folderId (numeric folder id), folderUid (folder unique identifier), folderTitle (folder title), folderUrl (full URL path to the folder).
Folder/Dashboard Search API query parameters
The GET /api/search/ endpoint accepts the following query parameters: query (Search Query), tag (List of tags to search for), type (Type to search for, 'dash-folder' or 'dash-db'), dashboardIds (List of dashboard ids to search for), dashboardUID (List of dashboard uids to search for, deprecated since Grafana v9.1, use dashboardUIDs instead), dashboardUIDs (List of dashboard uids to search for), folderUIDs (List of folder UIDs to search in), starred (Flag indicating if only starred Dashboards should be returned), limit (Limit the number of returned results, max is 5000, default is 1000; invalid values default to 1000), page (Use this parameter to access hits beyond limit, numbering starts at 1, limit param acts as page size).
Definition of exemplars
An exemplar is a specific trace representative of measurement taken in a given time interval. Exemplars link metrics and traces, allowing you to connect aggregated system views with fine-grained views of single requests.
Trace and span analysis panel structure
The trace analysis panel has three main segments: the top segment displays the trace ID; the middle segment shows the entire span as a narrow strip representing all trace levels from client to database; the bottom segment shows a magnified view of a smaller time segment when clicked in the strip view. You can expand or collapse trace levels by clicking the left icon to drill down to specific spans, and clicking on a span displays its associated metadata.
Add multiple traces to analysis results
When viewing exemplar trace details, you can add more traces to the results using the Add query button in the trace analysis panel.
How to view exemplar details
You can hover your cursor over an exemplar to view the unique trace ID, which is a combination of a key value pair. To investigate further, click the blue button next to the traceID property.
Exemplars display in Explore and dashboards
Grafana shows exemplars alongside a metric in the Explore view and in dashboards. Each exemplar displays as a highlighted star.
Use exemplars to isolate latency problems
Use exemplars to help isolate problems within your data distribution by pinpointing query traces exhibiting high latency within a time interval. After localizing the latency problem to a few exemplar traces, you can combine it with additional system-based information or location properties to perform root cause analysis faster.
Time series database tagging
Time series databases support filtering measurements using tags. Each data point is labeled with a tag that adds context information, such as where the measurement was taken or other identifying metadata.
Time series database TSDB optimizations
Time series databases are optimized specifically for time series data. They store timestamps as deltas from the first timestamp rather than absolute values, and can store delta-of-deltas for measurements taken at regular intervals where most changes are zero. These optimizations allow TSDBs to use drastically less disk space compared to regular databases.
Time series visualization benefits
Graph visualizations of time series data make it easier to discover patterns and features that would be difficult to see in tabular form. Visual representations help understand the past by analyzing system state at any point in time, and support predicting the future by uncovering trends. Seasonal patterns that repeat over known periods can be identified to make confident predictions about the next period.
Time series aggregation methods
Common aggregation methods for combining time series measurements include: Average (sum of all values divided by total number of values), Min and Max (smallest and largest values in the collection), Sum (sum of all values), and Count (number of values in the collection). The choice of aggregation method depends on the story you want to tell with your data.
Time series data collection push vs pull
Collectors can either push data to a time series database or allow the database to pull data from them. Push is easier to replicate data to multiple destinations but gives the TSDB no control over how much data gets sent. Pull provides better control of data ingestion amount and authenticity but can be hindered by firewalls, VPNs, or load balancers making it hard to access agents. Collectors typically pre-aggregate data before writing to the database at regular intervals.
Grafana supported time series databases
Grafana supports the following time series databases: Graphite, InfluxDB, and Prometheus.
Time series definition
A time series is a sequence of measurements ordered in time. Each measurement is recorded at a specific time point. New data is appended at regular intervals, and measurements are seldom updated after they are added. Time series data is commonly used to track metrics like CPU usage, memory usage, sensor data, and stock market indices.
LDAP optional configuration fields
Optional fields for LDAP configuration include: Bind DN (distinguished name of the user to bind to) and Bind password (password for the server).
LDAP configuration persistence and reset
To persist LDAP configuration changes made through the UI, click the Save button. To delete all changes made through the UI and revert to the configuration file settings, click the three dots menu icon and select Reset to default values.
LDAP configuration UI access path
LDAP authentication can be configured through the Grafana user interface by navigating to Administration > Authentication > LDAP.
LDAP extra security settings
LDAP extra security settings include: Enable SSL (enables SSL to connect to the LDAP server), Start TLS (uses StartTLS to secure the connection to the LDAP server), Min TLS version (choose minimum TLS version: TLS1.2 or TLS1.3), and TLS ciphers (list ciphers to use for the connection, refer to the Cipher Go library for complete list). Certificate and key can be provided as base-64 encoded (Root CA certificate content, Client certificate content, Client key content) or as file paths (Root CA certificate path, Client certificate path, Client key path).
LDAP group mapping configuration fields
Group mapping configuration fields for LDAP include: Skip organization role sync (avoids syncing organization roles for manual role management), Group search filter (LDAP search filter to find groups within the directory), Group search base DNS (list of base DNS to specify matching groups' locations), and Group name attribute (identifies users within group entries). When managing group mappings, additional fields are available: Add a group DN mapping (name of the key used to extract the ID token), Add an organization role mapping (select the Basic Role mapped to this group), Add the organization ID membership mapping (map the group to an organization ID), and Define Grafana Admin membership (enable Grafana Admin privileges to the group).
LDAP attribute mapping configuration
LDAP attributes used to map LDAP user assertion to Grafana user attributes are: Name (assertion attribute to map to Grafana user name), Surname (assertion attribute to map to Grafana user surname), Username (assertion attribute to map to Grafana user username), Member Of (assertion attribute to map to Grafana user membership), and Email (assertion attribute to map to Grafana user email).
LDAP miscellaneous settings
LDAP miscellaneous settings include: Allow sign-up (allows new users to register upon logging in), Port (port number of the LDAP server, default is 389), and Timeout (time in seconds to wait for a response from the LDAP server).
LDAP UI configuration overrides file and environment variables
Any configuration changes made through the Grafana user interface for LDAP authentication will take precedence over settings specified in the Grafana configuration file or through environment variables. If you modify any configuration settings in the UI, they will override any corresponding settings set via environment variables or defined in the configuration file.
LDAP mandatory configuration fields
The mandatory fields for LDAP configuration are: Server host (host name or IP address of the LDAP server), Search filter (LDAP search filter to find entries within the directory), and Search base DNS (list of base DNs to search through).
LDAP UI configuration benefits
Configuring LDAP authentication through the Grafana user interface provides the benefits of not needing to edit the configuration file manually, quickly testing the connection to the LDAP server, and not needing to restart Grafana after making changes.
LDAP UI configuration available from Grafana 11.3.0
LDAP authentication can be configured through the Grafana user interface starting with Grafana version 11.3.0 or later. This feature requires the ssoSettingsLDAP feature toggle to be enabled.
SAML response and request signing support
Grafana supports signed and encrypted responses. Grafana only supports signed requests, not encrypted requests.