From 89a7c8285ba5824932e118e433b5aaf0d240989e Mon Sep 17 00:00:00 2001 From: Linu-Elias Date: Fri, 30 Aug 2024 17:13:35 +0530 Subject: [PATCH] packages/microsoft_sqlserver: Update documentation (#10915) * Fix documentation issue on custom database metrics. --------- Co-authored-by: subham sarkar Co-authored-by: muthu-mps <101238137+muthu-mps@users.noreply.github.com> --- packages/microsoft_sqlserver/_dev/build/docs/README.md | 5 ++--- packages/microsoft_sqlserver/changelog.yml | 5 +++++ packages/microsoft_sqlserver/docs/README.md | 5 ++--- packages/microsoft_sqlserver/manifest.yml | 2 +- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/packages/microsoft_sqlserver/_dev/build/docs/README.md b/packages/microsoft_sqlserver/_dev/build/docs/README.md index 481ff82d07f..3f1223374d5 100644 --- a/packages/microsoft_sqlserver/_dev/build/docs/README.md +++ b/packages/microsoft_sqlserver/_dev/build/docs/README.md @@ -112,8 +112,7 @@ Read more in [instructions about each performance counter metrics](https://docs. #### Transaction log metrics -Collects system level `transaction_log` metrics information for SQL Server instance. -Metrics for user-level databases can be collected by providing a list of user databases for which metrics are to be collected. +The system-level database `transaction_log` metrics for SQL Server instances are collected by default. Metrics for user-level databases can be collected by specifying a list of user databases or by enabling the `Fetch from all databases` toggle to collect metrics from all databases on the server. Read more in [instructions and the operations supported by transaction log](https://docs.microsoft.com/en-us/sql/relational-databases/logs/the-transaction-log-sql-server?view=sql-server-ver15). @@ -167,7 +166,7 @@ Please refer to the following [document](https://www.elastic.co/guide/en/ecs/cur ### transaction_log -The Microsoft SQL Server `transaction_log` dataset provides metrics from the log space usage and log stats tables of the system databases. All `transaction_log` metrics will be available in the `sqlserver.metrics` field group. +The Microsoft SQL Server `transaction_log` dataset provides metrics from the log space usage and log stats tables. All `transaction_log` metrics will be available in the `sqlserver.metrics` field group. {{event "transaction_log"}} diff --git a/packages/microsoft_sqlserver/changelog.yml b/packages/microsoft_sqlserver/changelog.yml index 37d6e34c045..222413df75c 100644 --- a/packages/microsoft_sqlserver/changelog.yml +++ b/packages/microsoft_sqlserver/changelog.yml @@ -1,4 +1,9 @@ # newer versions go on top +- version: "2.9.2" + changes: + - description: Fix documentation for `transaction_logs` on default and custom database metrics. + type: bugfix + link: https://github.com/elastic/integrations/pull/10915 - version: "2.9.1" changes: - description: Convert error.code to string diff --git a/packages/microsoft_sqlserver/docs/README.md b/packages/microsoft_sqlserver/docs/README.md index 2ebf8ee4134..8bf6f8d90d1 100644 --- a/packages/microsoft_sqlserver/docs/README.md +++ b/packages/microsoft_sqlserver/docs/README.md @@ -112,8 +112,7 @@ Read more in [instructions about each performance counter metrics](https://docs. #### Transaction log metrics -Collects system level `transaction_log` metrics information for SQL Server instance. -Metrics for user-level databases can be collected by providing a list of user databases for which metrics are to be collected. +The system-level database `transaction_log` metrics for SQL Server instances are collected by default. Metrics for user-level databases can be collected by specifying a list of user databases or by enabling the `Fetch from all databases` toggle to collect metrics from all databases on the server. Read more in [instructions and the operations supported by transaction log](https://docs.microsoft.com/en-us/sql/relational-databases/logs/the-transaction-log-sql-server?view=sql-server-ver15). @@ -481,7 +480,7 @@ Please refer to the following [document](https://www.elastic.co/guide/en/ecs/cur ### transaction_log -The Microsoft SQL Server `transaction_log` dataset provides metrics from the log space usage and log stats tables of the system databases. All `transaction_log` metrics will be available in the `sqlserver.metrics` field group. +The Microsoft SQL Server `transaction_log` dataset provides metrics from the log space usage and log stats tables. All `transaction_log` metrics will be available in the `sqlserver.metrics` field group. An example event for `transaction_log` looks as following: diff --git a/packages/microsoft_sqlserver/manifest.yml b/packages/microsoft_sqlserver/manifest.yml index 2b785d22bfe..186b4f5391d 100644 --- a/packages/microsoft_sqlserver/manifest.yml +++ b/packages/microsoft_sqlserver/manifest.yml @@ -1,7 +1,7 @@ format_version: "3.0.2" name: microsoft_sqlserver title: "Microsoft SQL Server" -version: "2.9.1" +version: "2.9.2" description: Collect events from Microsoft SQL Server with Elastic Agent type: integration categories: