Skip to content

Commit

Permalink
[docs] Update MSSQL README (#8360)
Browse files Browse the repository at this point in the history
* address post-merge feedback in #8240

* add link to this pr
  • Loading branch information
colleenmcginnis committed Nov 1, 2023
1 parent 9758f9c commit bb17ebd
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
9 changes: 3 additions & 6 deletions packages/microsoft_sqlserver/_dev/build/docs/README.md
Expand Up @@ -2,29 +2,27 @@

The Microsoft SQL Server integration package allows you to search, observe, and visualize the SQL Server audit logs, as well as performance and transaction log metrics, through Elasticsearch.

For more information on SQL Server auditing, refer to [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).

## Data streams

The Microsoft SQL Server integration collects two types of data streams: logs and metrics.

**Logs** help you keep a record of events happening in Microsoft SQL Server.
Log data streams collected by the integration include:

* `audit` provides events from the configured Windows event log channel.
* `audit` provides events from the configured Windows event log channel. For more information on SQL Server auditing, refer to [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).
* `logs` parses error logs created by the Microsoft SQL server.

Other log sources, such as files, are not supported.

Find more details in [Logs](#logs-reference).
Find more details in [Logs](#logs).

**Metrics** give you insight into the state of Microsoft SQL Server.
Metric data streams collected by the integration include:

* `performance` metrics gather the list of performance objects available on that server. Each server will have a different list of performance objects depending on the installed software.
* `transaction_log` metrics collect all usage stats and the total space usage.

Find more details in [Metrics](#metrics-reference).
Find more details in [Metrics](#metrics).

## Requirements

Expand Down Expand Up @@ -52,7 +50,6 @@ For step-by-step instructions on how to set up any integration, refer to the

Below you'll find more specific details on setting up the Microsoft SQL Server integration.

<!-- Additional set up instructions -->
### Named Instance

Microsoft SQL Server has a feature that allows running multiple databases on the same host (or clustered hosts) with separate settings. Establish a named instance connection by using the instance name along with the hostname (e.g. `host/instance_name` or `host:named_instance_port`) to collect metrics. Details of the host configuration are provided below.
Expand Down
5 changes: 5 additions & 0 deletions packages/microsoft_sqlserver/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: 2.3.2
changes:
- description: Update documentation
type: enhancement
link: https://github.com/elastic/integrations/pull/8360
- version: 2.3.1
changes:
- description: Update README to use documentation guidelines
Expand Down
9 changes: 3 additions & 6 deletions packages/microsoft_sqlserver/docs/README.md
Expand Up @@ -2,29 +2,27 @@

The Microsoft SQL Server integration package allows you to search, observe, and visualize the SQL Server audit logs, as well as performance and transaction log metrics, through Elasticsearch.

For more information on SQL Server auditing, refer to [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).

## Data streams

The Microsoft SQL Server integration collects two types of data streams: logs and metrics.

**Logs** help you keep a record of events happening in Microsoft SQL Server.
Log data streams collected by the integration include:

* `audit` provides events from the configured Windows event log channel.
* `audit` provides events from the configured Windows event log channel. For more information on SQL Server auditing, refer to [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).
* `logs` parses error logs created by the Microsoft SQL server.

Other log sources, such as files, are not supported.

Find more details in [Logs](#logs-reference).
Find more details in [Logs](#logs).

**Metrics** give you insight into the state of Microsoft SQL Server.
Metric data streams collected by the integration include:

* `performance` metrics gather the list of performance objects available on that server. Each server will have a different list of performance objects depending on the installed software.
* `transaction_log` metrics collect all usage stats and the total space usage.

Find more details in [Metrics](#metrics-reference).
Find more details in [Metrics](#metrics).

## Requirements

Expand Down Expand Up @@ -52,7 +50,6 @@ For step-by-step instructions on how to set up any integration, refer to the

Below you'll find more specific details on setting up the Microsoft SQL Server integration.

<!-- Additional set up instructions -->
### Named Instance

Microsoft SQL Server has a feature that allows running multiple databases on the same host (or clustered hosts) with separate settings. Establish a named instance connection by using the instance name along with the hostname (e.g. `host/instance_name` or `host:named_instance_port`) to collect metrics. Details of the host configuration are provided below.
Expand Down
2 changes: 1 addition & 1 deletion packages/microsoft_sqlserver/manifest.yml
@@ -1,7 +1,7 @@
format_version: "3.0.0"
name: microsoft_sqlserver
title: "Microsoft SQL Server"
version: "2.3.1"
version: "2.3.2"
description: Collect events from Microsoft SQL Server with Elastic Agent
type: integration
categories:
Expand Down

0 comments on commit bb17ebd

Please sign in to comment.