# Datasentinel Docs

## Documentation

- [Welcome](https://docs.datasentinel.io/manual/welcome.md): Welcome to Datasentinel's new help center, your ultimate solution for effectively monitoring and analyzing the performance of your PostgreSQL clusters.
- [Free Trial](https://docs.datasentinel.io/manual/free-trial.md)
- [Architecture](https://docs.datasentinel.io/manual/getting-started/architecture.md): Datasentinel offers the flexibility to be used either On-Premises or in SaaS mode, with or without agents, enabling you to choose an architecture that best fits your needs.
- [Installation](https://docs.datasentinel.io/manual/getting-started/installation.md): For on-premises use of Datasentinel, platform installation is required. We advise utilizing a dedicated machine for optimal performance.
- [Platform](https://docs.datasentinel.io/manual/getting-started/installation/platform.md): Installation completes within minutes, ensuring that all components are operational upon completion.
- [Agent](https://docs.datasentinel.io/manual/getting-started/installation/agent.md): Datasentinel offers two monitoring approaches: agent-based and agentless. This guide focuses on the installation of an agent, applicable when you opt for the agent-based monitoring method.
- [PostgreSQL clusters](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters.md): Datasentinel has the capability to monitor hundreds of PostgreSQL clusters, and a single connection to a cluster is sufficient for overseeing all the existing databases within it.
- [Extensions](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/extensions.md): Datasentinel harnesses the power of multiple PostgreSQL extensions to deliver in-depth monitoring metrics on specific areas.
- [pg\_stat\_statements](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/extensions/pg_stat_statements.md): The pg\_stat\_statements extension allows to trace the execution statistics of all queries. It is an essential extension in understanding the activity of a PostgreSQL cluster.
- [pg\_store\_plans](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/extensions/pg_store_plans.md): The PostgreSQL extension pg\_store\_plans is a contrib module that provides a way to store execution plans generated by the query planner.
- [system\_stats](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/extensions/system_stats.md): system\_stats is a PostgreSQL extension that provides functions to access system level statistics that can be used for monitoring
- [pg\_buffercache](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/extensions/pg_buffercache.md): pg\_buffercache is a PostgreSQL contrib module offering a real-time method for inspecting activities within the shared buffer cache.
- [Monitoring User](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/monitoring-user.md)
- [Adding Connection](https://docs.datasentinel.io/manual/getting-started/postgresql-clusters/adding-connection.md)
- [FAQs](https://docs.datasentinel.io/manual/getting-started/faqs.md)
- [Platform FAQ](https://docs.datasentinel.io/manual/getting-started/faqs/platform-faq.md)
- [Agent FAQ](https://docs.datasentinel.io/manual/getting-started/faqs/agent-faq.md)
- [Key Features](https://docs.datasentinel.io/manual/features/key-features.md)
- [Session History](https://docs.datasentinel.io/manual/features/key-features/session-history.md): Datasentinel periodically samples active sessions, enabling in-depth analysis of your workload.
- [Top Queries](https://docs.datasentinel.io/manual/features/key-features/top-queries.md): The Top Queries feature allows you to identify the most consuming queries according to a chosen dimension.
- [Top Tables](https://docs.datasentinel.io/manual/features/key-features/top-tables.md): Datasentinel facilitates hourly collection of relations, supporting a Dimension-Based Analysis approach
- [Lock Explorer](https://docs.datasentinel.io/manual/features/key-features/lock-explorer.md): Lock explorer makes it easy to identify blocking sessions during blocked session issues, along with the associated queries and locks.
- [Cluster & System Metrics](https://docs.datasentinel.io/manual/features/key-features/cluster-and-system-metrics.md): Datasentinel gathers real-time PostgreSQL cluster metrics on a minute-by-minute basis, alongside database-specific measures encompassing transactions, cache hits, IO operations, among others.
- [Live360](https://docs.datasentinel.io/manual/features/key-features/live360.md): Datasentinel offers a direct connection feature to PostgreSQL instances, enabling real-time retrieval of information.
- [Reporting](https://docs.datasentinel.io/manual/features/key-features/reporting.md): The reporting feature allows you to define different types of activity reports for analysis purposes
- [Alerting](https://docs.datasentinel.io/manual/features/key-features/alerting.md): The alerting functionality empowers you to effectively oversee your PostgreSQL instances, enabling prompt notifications in the event of any issues.
- [Settings](https://docs.datasentinel.io/manual/features/key-features/alerting/settings.md)
- [Templates](https://docs.datasentinel.io/manual/features/key-features/alerting/templates.md): Defining notification templates is the next step after enabling Alerting at the platform level.
- [Silences](https://docs.datasentinel.io/manual/features/key-features/alerting/silences.md): Activating a silence period deactivates the alerting mechanism for one or multiple instances. This proves particularly beneficial during maintenance tasks.
- [Manager](https://docs.datasentinel.io/manual/features/key-features/alerting/manager.md): Various methods exist for both viewing and managing notifications.
- [Other Features](https://docs.datasentinel.io/manual/features/other-features.md)
- [Agentless Monitoring](https://docs.datasentinel.io/manual/features/other-features/agentless-monitoring.md): Datasentinel offers an agentless approach for remote monitoring of PostgreSQL clusters, eliminating the need for local agent installations.
- [Role Based Access](https://docs.datasentinel.io/manual/features/other-features/role-based-access.md): Datasentinel offers Role-Based Access Control, enabling precise restriction of designated users to specific perimeters among the total instances available.
- [Execution Plans](https://docs.datasentinel.io/manual/features/other-features/execution-plans.md): Execution plans provide detailed insight into how PostgreSQL executes SQL queries. They describe the steps chosen by the query planner, the access methods used, join strategies, ...
- [Changed Parameters](https://docs.datasentinel.io/manual/features/other-features/changed-parameters.md): Datasentinel automatically checks for changes in parameters every hour.
- [Tips & Hints](https://docs.datasentinel.io/manual/features/tips-and-hints.md)
- [User Interface](https://docs.datasentinel.io/manual/features/tips-and-hints/user-interface.md): Built as a specialized plugin for the Grafana framework, Datasentinel offers an intuitive interface that allows users to become adept within minutes
- [Tags](https://docs.datasentinel.io/manual/features/tips-and-hints/tags.md): A tag is comprised of both a key and a corresponding value, working together to represent a distinct property.
- [Metric Correlation](https://docs.datasentinel.io/manual/features/tips-and-hints/metric-correlation.md): This ability to correlate metrics greatly enhances analytical capabilities by effortlessly revealing potential relationships and patterns between separate measurements.
- [Consolidated View](https://docs.datasentinel.io/manual/features/tips-and-hints/consolidated-view.md): One of the standout features of Datasentinel is its ability to provide a consolidated view of multiple instances concurrently.
- [Graphical Annotations](https://docs.datasentinel.io/manual/features/tips-and-hints/graphical-annotations.md): The main dashboards employ graphical annotations to spotlight significant events, delivering an instant visual summary.
- [Predefined Providers](https://docs.datasentinel.io/manual/features/tips-and-hints/predefined-providers.md): DataSentinel allows users to associate their monitored PostgreSQL instances with specific providers.
- [Wait Event Description](https://docs.datasentinel.io/manual/features/tips-and-hints/wait-event-description.md): A wait event in PostgreSQL is a fundamental concept used in performance monitoring and tuning.
- [Read Replicas](https://docs.datasentinel.io/manual/features/tips-and-hints/read-replicas.md): Datasentinel offers efficient monitoring of PostgreSQL Read Replicas through read-only access. It supports both local agent-based and agentless setups, ensuring flexible and seamless integration.
- [Agentless & System Metrics](https://docs.datasentinel.io/manual/features/tips-and-hints/agentless-and-system-metrics.md): One of the features of Datasentinel is its ability to offer comprehensive monitoring of PostgreSQL clusters without the need for installing agents on your database servers.
- [Query Identifier](https://docs.datasentinel.io/manual/features/tips-and-hints/query-identifier.md): From the beginning, Datasentinel has relied on an MD5 hash of the query text to compute query identifiers.
- [Simplified pg\_instance Display](https://docs.datasentinel.io/manual/features/tips-and-hints/simplified-pg_instance-display.md): Created by Datasentinel, the pg\_instance tag is a unique identifier for your instance across the platform.
- [Platform Usage](https://docs.datasentinel.io/manual/implementation/platform-usage.md)
- [Configuration](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration.md)
- [License](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/license.md): The license is provided in the form of a token with a restricted time of validity.
- [LDAP](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/ldap.md): Datasentinel seamlessly integrates with LDAP for user authentication.
- [SMTP](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/smtp.md): SMTP (Simple Mail Transfer Protocol) is required for sending email notifications and workload reports. It ensures reliable delivery of messages, enabling real-time alerts and efficient report sharing
- [Audit](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/audit.md): Datasentinel can audit the actions performed by your declared users on the platform.
- [Default RBAC Behavior](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/default-rbac-behavior.md)
- [Users & Roles](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/users-and-roles.md): Datasentinel employs a multi-layered approach to secure user access to its platform and control who can access monitored PostgreSQL instances.
- [Backend](https://docs.datasentinel.io/manual/implementation/platform-usage/configuration/backend.md)
- [API Reference](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference.md)
- [Access Token](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/access-token.md): To enable interaction with the Platform API, it is necessary to generate an access token.This access token is subsequently used when making calls to the API.
- [Connection](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/connection.md): The Connection API is available solely through an on-premises installation and is reliant on the decision to use the Agentless feature.
- [Role](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/role.md)
- [User](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/user.md)
- [Reporting](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/reporting.md)
- [Workload](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/workload.md): The Workload API provides you with the option to download comprehensive metrics in either JSON or CSV format.
- [Alerting](https://docs.datasentinel.io/manual/implementation/platform-usage/api-reference/alerting.md)
- [Tooling](https://docs.datasentinel.io/manual/implementation/platform-usage/tooling.md): Datasentinel provides tooling to help you troubleshoot problems or gather information about system configurations.
- [Log Files](https://docs.datasentinel.io/manual/implementation/platform-usage/log-files.md): Datasentinel generates logs, which are located in the /datasentinel/log directory, except for the NGINX log file.
- [Agent Usage](https://docs.datasentinel.io/manual/implementation/agent-usage.md)
- [Release Notes](https://docs.datasentinel.io/manual/implementation/agent-usage/release-notes.md): All releases are cumulative. Upgrading to the latest version includes all previous changes, so it's sufficient to install or run only the most recent release.
- [CLI](https://docs.datasentinel.io/manual/implementation/agent-usage/cli.md): The agent offers a CLI for conveniently modifying attributes and connections.
- [API Reference](https://docs.datasentinel.io/manual/implementation/agent-usage/api-reference.md): The agent's setup is adjustable using direct API invocations, facilitating interactive information retrieval and interaction.
- [Collection Level](https://docs.datasentinel.io/manual/implementation/agent-usage/collection-level.md): The Agent version 3.2, which was released in February 2023, introduces the Collection Level feature allowing you to choose the metrics to monitor.
- [Internals](https://docs.datasentinel.io/manual/implementation/agent-usage/internals.md)
- [Upgrade](https://docs.datasentinel.io/manual/implementation/upgrade.md)
- [Platform](https://docs.datasentinel.io/manual/implementation/upgrade/platform.md): Procedure to upgrade your on-premises platform.
- [Agent](https://docs.datasentinel.io/manual/implementation/upgrade/agent.md): Upgrading an agent involves completely replacing the old version with the new version.
- [Troubleshooting](https://docs.datasentinel.io/manual/implementation/troubleshooting.md)
- [Platform Diagnostics Tools](https://docs.datasentinel.io/manual/implementation/troubleshooting/platform-diagnostics-tools.md): Starting with version 2025.11, two new diagnostic scripts are available to help identify issues and assist the support team.
- [Unexpected Agent Termination](https://docs.datasentinel.io/manual/implementation/troubleshooting/unexpected-agent-termination.md): In some cases, the Agent may stop running without any visible error or warning.
- [Error message: “502 Bad Gateway”](https://docs.datasentinel.io/manual/implementation/troubleshooting/error-message-502-bad-gateway.md)
- [The UI is not displaying any metrics for my new instance.](https://docs.datasentinel.io/manual/implementation/troubleshooting/the-ui-is-not-displaying-any-metrics-for-my-new-instance..md)
- [UI dashboard is encountering loading errors](https://docs.datasentinel.io/manual/implementation/troubleshooting/ui-dashboard-is-encountering-loading-errors.md)
- [InfluxDB](https://docs.datasentinel.io/manual/implementation/troubleshooting/influxdb.md): InfluxDB is an open-source time series database used by Datasentinel to store collected metrics and manage data retention.
- [SELinux](https://docs.datasentinel.io/manual/implementation/troubleshooting/selinux.md): Security-Enhanced Linux (SELinux) is a Linux kernel security module that provides a mechanism for supporting access control security policies, including mandatory access controls (MAC).
- [NGINX](https://docs.datasentinel.io/manual/implementation/troubleshooting/nginx.md): NGINX sits at the edge of a Datasentinel deployment and acts as a reverse proxy. All inbound HTTPS traffic terminates at NGINX before being forwarded to the internal Datasentinel services.
- [How to Contact Us](https://docs.datasentinel.io/manual/support/how-to-contact-us.md): Need Assistance? Encountered a Bug?

## Changelog

- [2026](https://docs.datasentinel.io/manual/changelog/2026.md): All releases are cumulative. Upgrading to the latest version includes all previous changes.It's sufficient to install or run only the most recent release.
- [2025](https://docs.datasentinel.io/manual/changelog/2025.md): Datasentinel releases from 2025.
- [2024](https://docs.datasentinel.io/manual/changelog/2024.md): Datasentinel releases from 2024.
- [2023](https://docs.datasentinel.io/manual/changelog/2023.md): Datasentinel releases from 2023.
- [2022](https://docs.datasentinel.io/manual/changelog/2022.md): Datasentinel releases from 2022.
- [2021](https://docs.datasentinel.io/manual/changelog/2021.md): Datasentinel releases from 2021.
- [2020](https://docs.datasentinel.io/manual/changelog/2020.md): Datasentinel releases from 2020.
- [2019](https://docs.datasentinel.io/manual/changelog/2019.md): Datasentinel releases from 2019.

## Guides

- [Guides](https://docs.datasentinel.io/manual/guides/readme.md): Each guide is designed to walk you through a specific task, from initial setup to advanced operations, with clear explanations and practical examples.
- [Generate, Email, and Schedule PDF Reports](https://docs.datasentinel.io/manual/guides/readme/pdf-reports.md): Produce, email, and schedule PDF reports of your PostgreSQL workload. Keep them as long-term snapshots without paying the storage cost of extended metric retention, and use two reports as a before/aft
- [Install On-Premises and Configure Agentless Connections](https://docs.datasentinel.io/manual/guides/readme/install-on-premises-and-agentless.md): Install the Datasentinel platform on a single Linux server, then connect your PostgreSQL instances agentlessly, with no agent to deploy on the database hosts.
- [Onboard Your First PostgreSQL Cluster](https://docs.datasentinel.io/manual/guides/readme/onboard-your-first-cluster.md): The golden path from a brand-new PostgreSQL instance to a fully monitored cluster: extensions, monitoring user, network access, connection, and tags.
- [Automate with the API](https://docs.datasentinel.io/manual/guides/readme/automate-with-the-api.md): Drive Datasentinel programmatically — provision monitored instances, manage users and roles, export metrics, schedule reports, and control agents through the REST API.
- [Monitor Cloud-Managed Instances](https://docs.datasentinel.io/manual/guides/readme/monitor-cloud-managed-instances.md): Datasentinel supports monitoring of managed PostgreSQL instances from major cloud providers, including Amazon Web Services, Google Cloud, and Microsoft Azure, among others.
- [Monitor High-Availability Clusters](https://docs.datasentinel.io/manual/guides/readme/monitor-high-availability-clusters.md): Datasentinel supports monitoring high-availability (HA) PostgreSQL clusters, allowing activity analysis across primary and replica instances from a single, consolidated view.
- [Manage Users and Role-Based Access](https://docs.datasentinel.io/manual/guides/readme/manage-users-and-role-based-access.md): Datasentinel provides role-based access control (RBAC) to restrict user access to PostgreSQL instances based on tags.
- [Organize Content using Tags](https://docs.datasentinel.io/manual/guides/readme/organize-content-using-tags.md): Label instances with custom tags to filter dashboards, consolidate workloads, and scope user access.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.datasentinel.io/manual/welcome.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.