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.

Sign up for GitHub

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

Jump to bottom

[doc] Add encoding in log config sample #7708

Merged
merged 3 commits into from
Oct 6, 2020
Merged

[doc] Add encoding in log config sample #7708

merged 3 commits into from
Oct 6, 2020

Conversation

prognant
Copy link
Contributor

@prognant prognant commented Oct 2, 2020 •
edited
Loading

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

@prognant prognant requested review from a team as code owners October 2, 2020 13:49
yzhan289
yzhan289 reviewed Oct 2, 2020
View reviewed changes
sqlserver/datadog_checks/sqlserver/data/conf.yaml.example Outdated
@@ -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
View reviewed changes
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

@prognant prognant force-pushed the prognant/sqlserver-utf16-encoding branch from 3f4c4e6 to 8ac88fb Compare October 2, 2020 15:17
@prognant prognant force-pushed the prognant/sqlserver-utf16-encoding branch from 8ac88fb to 2f4185d Compare October 2, 2020 15:27
@prognant prognant requested a review from anshumgargdd as a code owner October 2, 2020 15:27
@hithwen hithwen merged commit 09e5c98 into master Oct 6, 2020
@hithwen hithwen deleted the prognant/sqlserver-utf16-encoding branch October 6, 2020 12:54
kayayarai
kayayarai reviewed Oct 6, 2020
View reviewed changes
active_directory/datadog_checks/active_directory/data/conf.yaml.example
@@ -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
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kayayarai kayayarai kayayarai left review comments

@hithwen hithwen hithwen approved these changes

@apigirl apigirl apigirl left review comments

@anshumgargdd anshumgargdd Awaiting requested review from anshumgargdd

@yzhan289 yzhan289 Awaiting requested review from yzhan289

Assignees
No one assigned
Labels
dev/tooling documentation integration/active_directory integration/activemq integration/airflow integration/ambari integration/apache integration/cassandra integration/ceph integration/clickhouse integration/confluent_platform integration/consul integration/couch integration/couchbase integration/datadog_checks_dev integration/druid integration/elastic integration/envoy integration/flink integration/gearmand integration/gitlab_runner integration/gitlab integration/gunicorn integration/haproxy integration/hazelcast integration/hdfs_datanode integration/hdfs_namenode integration/hive integration/hivemq integration/ibm_mq integration/ignite integration/jboss_wildfly integration/kafka integration/kong integration/mapreduce integration/marathon integration/marklogic integration/mongo integration/mysql integration/nginx integration/pgbouncer integration/postgres integration/rabbitmq integration/redisdb integration/rethinkdb integration/riak integration/sidekiq integration/solr integration/spark integration/sqlserver integration/squid integration/supervisord integration/tenable integration/tomcat integration/varnish integration/vault integration/vertica integration/yarn integration/zk
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@prognant @hithwen @kayayarai @apigirl @yzhan289