Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

packages/microsoft_sqlserver: Update documentation #10915

Merged
merged 4 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions packages/microsoft_sqlserver/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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"}}

Expand Down
5 changes: 5 additions & 0 deletions packages/microsoft_sqlserver/changelog.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 2 additions & 3 deletions packages/microsoft_sqlserver/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion packages/microsoft_sqlserver/manifest.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down