Skip to content

Commit 3780c37

Browse files
sumoanemaJV0812kimsauce
authored
Postgresql opentelemtry app enhanced with newly contributed metrics (#5287)
* Postgresql opentelemtry app enhanced with newly contributed metrics * Update postgresql-opentelemetry.md * Update docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md * Update docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md * Apply suggestions from code review Co-authored-by: Kim (Sumo Logic) <[email protected]> --------- Co-authored-by: Jagadisha V <[email protected]> Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 207a5bc commit 3780c37

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem';
1515

1616
The Sumo Logic app for PostgreSQL includes predefined searches and dashboards that allow you to monitor logs and metrics for the database. The logs enable you to monitor database activity, user activity, incoming connections, query execution time, and errors. The metrics allow you to monitor database resource utilization and throughput performance.
1717

18-
This app supports PostgreSQL version 9.6+.
18+
This app supports PostgreSQL version 13+.
1919

2020
We use the OpenTelemetry collector for PostgreSQL metric collection and for collecting PostgreSQL logs.
2121

@@ -41,7 +41,7 @@ Following are the tags that will be created as part of PostgreSQL app installati
4141
### For metrics collection
4242

4343
- This collection queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/9.6/monitoring-stats.html).
44-
- This receiver supports PostgreSQL version 9.6+.
44+
- This receiver supports PostgreSQL version 13+.
4545
- The monitoring user must be granted **SELECT** on the `pg_stat_database`.
4646

4747
### For logs collection
@@ -115,6 +115,7 @@ Below is the required input:
115115
- **Endpoint**. Enter the url of the server which needs to be monitored. Default endpoint is `localhost:5432`.
116116
- **UserName**. Enter the PostgreSQL username.
117117
- **Password**. Password for the user name which is being used for scrapping the PostgreSQL metrics.
118+
- **Collection Interval**. You can specify at what interval should the metrics be collected. Default is 5 minutes.
118119

119120
You can add any custom fields which you want to tag along with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file.
120121

@@ -246,6 +247,7 @@ Use this dashboard to:
246247
- Determine the number of active databases and clusters.
247248
- Drill-down into database errors, failed logins and slow queries.
248249
- Determine if your database or queries need to be tuned based on comparing the number of slow queries.
250+
- Active deadlock value and tuple operations trends.
249251

250252
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Postgresql-OpenTelemetry/PostgreSQL-Overview.png' alt="Overview" />
251253

@@ -267,8 +269,11 @@ The **PostgreSQL - Database Metrics** dashboard allows you to monitor the databa
267269
Use this dashboard to:
268270

269271
- Understand the behavior and performance of your database clusters.
270-
- Monitor database size and disk usage.
272+
- Monitor the database size and disk usage.
271273
- Identify top 5 and least 5 frequently scanned indexes.
274+
- Monitor the row return and fetched ratio, block hits by database.
275+
- Identify the number of Locks and Deadlocks.
276+
- Identify the rows Update/Deleted/Inserted count trend.
272277

273278
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Postgresql-OpenTelemetry/PostgreSQL-Database-Metrics.png' alt="Database Metrics" />
274279

@@ -281,6 +286,7 @@ Use this dashboard to view:
281286
- Head Only Tuple updated by schema.
282287
- Disk block reads and Disk usage by schema.
283288
- Buffer hits and rows inserted, updated and deleted by schema.
289+
- Live rows by schema.
284290

285291
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Postgresql-OpenTelemetry/PostgreSQL-Schema-Metrics.png' alt="Schema Metrics" />
286292

@@ -333,6 +339,8 @@ Use this dashboard to:
333339
- Monitor PostgreSQL relation metrics (disk blocks, buffer hits, and hot updates) trends over time.
334340
- Monitor index scans and size to determine if executed queries are accessing them for a relation.
335341
- Track index utilization of existing indexes in a relation.
342+
- Monitor the PostgreSQL live and dead rows count trend.
343+
- Monitor the sequential scans and index scans by relation.
336344

337345
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Postgresql-OpenTelemetry/PostgreSQL-Relation-Metrics.png' alt="Relation Metrics" />
338346

@@ -352,4 +360,5 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
352360
| `PostgreSQL - Instance Down Alert` | This alert gets triggered when the Postgres instance is down. | Count > = 1 | Count < 1 |
353361
| `PostgreSQL - SlowQueries Alert` | This alert gets triggered when we detect that the PostgreSQL instance is executing slow queries. | Count > 5 | Count < = 5 |
354362
| `Postgresql- Too Many Connections Alert` | PostgreSQL instance has too many connections. | Count > = 100 | Count < 100 |
355-
| `Postgresql - Too Many Locks Acquired Alert` | This alert gets triggered when we detect that there are too many locks acquired on the database. If this alert happens frequently, you may need to increase the postgres setting `max_locks_per_transaction`. | Count > = 100 | Count < 100 |
363+
| `PostgreSQL - Too Many Locks Acquired Alert` | This alert is triggered when there are too many locks acquired on the database. Increase the postgres setting `max_locks_per_transaction`, if this alert occurs frequently. | Count > = 100 | Count < 100 |
364+
| `PostgreSQL - High Rate Deadlock` | This alert is triggered when deadlocks in a Postgres instance are detected. | Count > = 1 | Count < 1 |

0 commit comments

Comments
 (0)