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: Improve documentation #11646

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
27 changes: 19 additions & 8 deletions packages/microsoft_sqlserver/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,19 @@ The Microsoft SQL Server integration package allows you to search, observe, and

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:
**Log** data streams provide records of events happening in Microsoft SQL Server:

* `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.
* `audit` - Events from the configured Windows event log channel, providing detailed auditing information. See [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).
* `logs` - Error logs created by the Microsoft SQL server for troubleshooting and system events.

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

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:
**Metrics** data streams provide insights into SQL Server performance and health:

* `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.
* `performance` — Comprehensive performance counters and objects available on the server.
* `transaction_log` — Usage statistics and space utilization metrics for transaction logs.

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

Expand All @@ -42,6 +40,19 @@ If you browse Microsoft Developer Network (MSDN) for the following tables, you w
2. `performance`:
- [sys.dm_os_performance_counters](https://learn.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-performance-counters-transact-sql?view=sql-server-ver16)

Please make sure the user has the permissions to system as well as user-defined databases. For the particular user used in the integration, the following requirements are met:

User setup options:

- Grant specific permissions as mentioned in the MSDN pages above.
- Alteratively, use `sysadmin` role (includes all required permissions): This can be configured via SQL Server Management Studio (SSMS) in `Server Roles`.

User Mappings (using SQL Server Management Studio (SSMS)):

- Open SSMS and connect to your server.
- Navigate to "Object Explorer" > "Security" > "Logins".
- Right-click the user and select "Properties".
- In the "User Mapping" tab, select the appropriate database and grant the required permissions.

## Setup

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.3"
changes:
- description: Improve documentation to add more information about required permissions.
type: enhancement
link: https://github.com/elastic/integrations/pull/11646
- version: "2.9.2"
changes:
- description: Fix documentation for `transaction_logs` on default and custom database metrics.
Expand Down
27 changes: 19 additions & 8 deletions packages/microsoft_sqlserver/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,19 @@ The Microsoft SQL Server integration package allows you to search, observe, and

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:
**Log** data streams provide records of events happening in Microsoft SQL Server:

* `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.
* `audit` - Events from the configured Windows event log channel, providing detailed auditing information. See [SQL Server Audit](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-database-engine?view=sql-server-ver15).
* `logs` - Error logs created by the Microsoft SQL server for troubleshooting and system events.

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

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:
**Metrics** data streams provide insights into SQL Server performance and health:

* `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.
* `performance` — Comprehensive performance counters and objects available on the server.
* `transaction_log` — Usage statistics and space utilization metrics for transaction logs.

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

Expand All @@ -42,6 +40,19 @@ If you browse Microsoft Developer Network (MSDN) for the following tables, you w
2. `performance`:
- [sys.dm_os_performance_counters](https://learn.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-performance-counters-transact-sql?view=sql-server-ver16)

Please make sure the user has the permissions to system as well as user-defined databases. For the particular user used in the integration, the following requirements are met:

User setup options:

- Grant specific permissions as mentioned in the MSDN pages above.
- Alteratively, use `sysadmin` role (includes all required permissions): This can be configured via SQL Server Management Studio (SSMS) in `Server Roles`.

User Mappings (using SQL Server Management Studio (SSMS)):

- Open SSMS and connect to your server.
- Navigate to "Object Explorer" > "Security" > "Logins".
- Right-click the user and select "Properties".
- In the "User Mapping" tab, select the appropriate database and grant the required permissions.

## Setup

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.2"
version: "2.9.3"
description: Collect events from Microsoft SQL Server with Elastic Agent
type: integration
categories:
Expand Down