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

[doc] Add encoding in log config sample #7708

Merged
merged 3 commits into from
Oct 6, 2020

Conversation

prognant
Copy link
Contributor

@prognant prognant commented Oct 2, 2020

What does this PR do?

Add the encoding option for log configuration templates.

As per https://docs.microsoft.com/en-us/sql/linux/sql-server-linux-troubleshooting-guide?view=sql-server-ver15#access-the-log-files the log are encoded using utf-16-le by default so the default config for this integration has been updated accordingly.

Motivation

Windows support.

Additional Notes

N/A

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have changelog/ and integration/ labels attached

@@ -120,6 +120,7 @@ instances:
## Set channel_path if type is windows_event.
## source - required - Attribute that defines which Integration sent the logs.
## service - optional - The name of the service that generates the log.
## encoding - optional - Set the file encoding, SQL Server error log uses utf-16-le.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of directly changing the conf.yaml.example, you could modify the spec.yaml file (sqlserver/assets/configuration/spec.yaml) since we run a script to automatically generate the conf.yaml.example now. There is a template for logs (datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/logs.yaml), which you can just use and override to include the additional encoding information.

apigirl
apigirl previously approved these changes Oct 2, 2020
Copy link
Contributor

@apigirl apigirl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 from docs

@hithwen hithwen merged commit 09e5c98 into master Oct 6, 2020
@hithwen hithwen deleted the prognant/sqlserver-utf16-encoding branch October 6, 2020 12:54
@@ -94,6 +94,8 @@ instances:
## Set path if type is file.
## Set channel_path if type is windows_event.
## source - required - Attribute that defines which Integration sent the logs.
## encoding - optional - For file specifies the file encoding, default is utf-8, other
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifies the encoding for the file. The default is utf-8. Other

@coignetp coignetp mentioned this pull request Oct 7, 2020
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants