Skip to content

Commit

Permalink
Merge pull request #1991 from EnterpriseDB/docs/biganimal/metrics-edits
Browse files Browse the repository at this point in the history
quick edit on Metrics topic
  • Loading branch information
drothery-edb authored Nov 2, 2021
2 parents 93e1ef6 + a183c0e commit a64ffd5
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 20 deletions.
2 changes: 1 addition & 1 deletion product_docs/docs/biganimal/release/reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Using the BigAnimal CLI
---


Use the Command Line Interface (CLI) for BigAnimal management activities such as cluster provisioning and getting cluster status from your terminal. The CLI is an efficient way to integrate with BigAnimal and enables system administrators and developers to script and automate the EDB Cloud administrative operations.
Use the Command Line Interface (CLI) for BigAnimal management activities such as cluster provisioning and getting cluster status from your terminal. The CLI is an efficient way to integrate with BigAnimal and enables system administrators and developers to script and automate the BigAnimal administrative operations.



Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/biganimal/release/reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ navigation:
- cli
---

In this section, system administrators and developers can learn how to use the EDB Cloud API and EDB Cloud Command Line Interface (CLI) to integrate directly with EDB Cloud for management activities such as cluster provisioning, de-provisioning, and scaling and to automate administrative operations.
In this section, system administrators and developers can learn how to use the BigAnimal API and BigAnimal Command Line Interface (CLI) to integrate directly with BigAnimal for management activities such as cluster provisioning, de-provisioning, and scaling and to automate administrative operations.
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "Metrics Details"
title: "Metrics details"
---

A variety of metrics are collected by the BigAnimal instance and made available
to the customer's Azure subscription for dashboarding, alerting, querying and
other analytics.

See [Monitoring and Logging](#monitoring-and-logging) for an introduction to
See [Monitoring and logging](#monitoring-and-logging) for an introduction to
the available monitoring capabilities.

This section explains how to find and interpret the available metrics and logs.
It also lists and describes the individual metrics provided.

## Understanding BigAnimal Logs and Metrics
## Understanding BigAnimal logs and metrics

You can see example queries over these metrics by editing the predefined
dashboard panels in the default shared dashboard. Some pre-defined queries
Expand All @@ -27,9 +27,9 @@ Azure Monitor. A wide variety of analytics capabilities are available including
time-series functions, seasonally adjusted statistics, alert generation and
more.

## Available Logs and Metrics
## Available logs and metrics

The following tables in the _Customer Log Analytic workspace_ contain entries
The following tables in the Customer Log Analytic workspace contain entries
specific to BigAnimal:

| Table name | Description |
Expand All @@ -50,20 +50,20 @@ Logs are split into structured fields matching those of the Postgres
with a `record_` prefix and a type-suffix. For example the `application_name`
is in the `record_application_name_s` log field.

The `pg_cluster_id_s` field identifies the specific postgres cluster
The `pg_cluster_id_s` field identifies the specific Postgres cluster
that originated the log message.

## Metrics Overview
## Metrics overview

BigAnimal collects a wide set of metrics about postgres instances into the
BigAnimal collects a wide set of metrics about Postgres instances into the
`InsightsMetrics` log analytics table. Most of these metrics are acquired
directly from postgres system tables, views, and functions. The postgres
directly from Postgres system tables, views, and functions. The Postgres
documentation serves as the main reference for these metrics.

KQL can be used to analyze time-series metrics, report latest samples of
metrics, etc by querying the `InsightsMetrics` table.

Some data from postgres monitoring system views, tables and functions are
Some data from Postgres monitoring system views, tables and functions are
transformed to be easier to consume in Prometheus metrics format. For example,
timestamp fields are generally converted to unix epoch time and/or accompanied
by a relative time-interval metric. Other metrics are aggregated into
Expand Down Expand Up @@ -91,13 +91,13 @@ meaning or type of existing metrics without also changing the metric name.
At time of writing all metrics forwarded from Prometheus are in the
`prometheus` namespace. This may change in a future release.

Effective use of the available metrics will require an understanding of Azure
Effective use of the available metrics requires an understanding of Azure
time-series data, metrics dimensions, and of the tagging conventions used in
the metrics streams.

### Metrics tags

All postgres metrics share a common tagging scheme. Entries will generally
All Postgres metrics share a common tagging scheme. Entries will generally
have at least the following tags:

| Name | Description |
Expand Down Expand Up @@ -582,10 +582,9 @@ See also:
Additional streams of metrics may be supplied by the cloud platform itself
directly to the customer's metrics, analytics and dashboarding endpoint.

### Dive Deeper
### Dive deeper

The capabilities available in the Azure portal are too broad to fully cover in this
documentation. They include the ability to:
Other capabilities available in the Azure portal, outside the scope of this documentation, include the ability to:

* Discover metrics in the Azure Monitor Metrics Explorer (Monitor -> Metrics)
* Query logs and metrics from the Azure Monitor Logs view (Monitor -> Logs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: "Monitoring and logging"
---

You can monitor your Postgres clusters by viewing the metrics and logs from Azure. For existing Postgres Enterprise Manager (PEM) users who wish to monitor EDB Cloud clusters alongside self-managed Postgres clusters, you can use the remote Remote Monitoring capability of PEM. For more information on using PEM to monitor your clusters see [Remote Monitoring](../../../../../pem/latest/pem_admin/02a_pem_remote_monitoring).
You can monitor your Postgres clusters by viewing the metrics and logs from Azure. For existing Postgres Enterprise Manager (PEM) users who wish to monitor BigAnimal clusters alongside self-managed Postgres clusters, you can use the remote Remote Monitoring capability of PEM. For more information on using PEM to monitor your clusters see [Remote Monitoring](../../../../../pem/latest/pem_admin/02a_pem_remote_monitoring).

The following sections describe viewing metrics and logs directly from Azure.
The following sections describe viewing metrics and logs directly from Azure. See [Metrics details](06_metrics) for more information.

## Viewing metrics and logs from Azure

EDB Cloud sends all metrics and logs from PostgreSQL clusters to Azure. The following describes what metrics and logs are sent and how to view them.
BigAnimal sends all metrics and logs from PostgreSQL clusters to Azure. The following describes what metrics and logs are sent and how to view them.

### Azure log analytics

Expand Down

0 comments on commit a64ffd5

Please sign in to comment.