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

Add logs section #3097

Merged
merged 4 commits into from
Feb 14, 2019
Merged

Add logs section #3097

merged 4 commits into from
Feb 14, 2019

Conversation

nmuesch
Copy link
Contributor

@nmuesch nmuesch commented Feb 11, 2019

What does this PR do?

Adds logs section to readme and example yaml file.
Adds the log collection category to the manifest file

Most of this info came from here - http://www.postfix.org/BASIC_CONFIGURATION_README.html#syslog_howto

Motivation

We now have an OOTB logs pipeline for postfix so update the docs and yaml to reflect that.

Review checklist

  • PR has a meaningful title or PR has the no-changelog label attached
  • Feature or bugfix has tests
  • Git history is clean
  • If PR impacts documentation, docs team has been notified or an issue has been opened on the documentation repo
  • If PR adds a configuration option, it has been added to the configuration file.

Additional Notes

Anything else we should know when reviewing?

postfix/README.md Outdated Show resolved Hide resolved
postfix/README.md Outdated Show resolved Hide resolved
postfix/README.md Outdated Show resolved Hide resolved
postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
##
## type - mandatory - Type of log input source (tcp / udp / file / windows_event)
## port / path / channel - mandatory - Set port if type is tcp or udp. Set path if type is file and channel if windows_event
## service - mandatory - Name of the service owning the log
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## service - mandatory - Name of the service owning the log
## service - mandatory - Name of the service that owns the log

Is that accurate? Or is it the name of the service that generates the logs, for example?

Copy link
Contributor

Choose a reason for hiding this comment

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

it's the name of the service that generates the logs not own it, since we want to bind those logs to the corresponding APM service.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, got it. Let's be clear about that.

Suggested change
## service - mandatory - Name of the service owning the log
## service - mandatory - Name of the service that generated the log

postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
@nmuesch
Copy link
Contributor Author

nmuesch commented Feb 12, 2019

Thanks @l0k0ms and @phrawzty ! I've addressed the reviews above. I'll keep this PR scoped to just the postfix integration, but we can work on fixing the other integration's configs/readme-s for clarity in a future PR.

postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
##
## type - mandatory - Type of log input source (tcp / udp / file / windows_event)
## port / path / channel - mandatory - Set port if type is tcp or udp. Set path if type is file and channel if windows_event
## service - mandatory - Name of the service owning the log
Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, got it. Let's be clear about that.

Suggested change
## service - mandatory - Name of the service owning the log
## service - mandatory - Name of the service that generated the log

postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
postfix/datadog_checks/postfix/data/conf.yaml.example Outdated Show resolved Hide resolved
@nmuesch
Copy link
Contributor Author

nmuesch commented Feb 13, 2019

Thanks for the suggestions/review. I think I've addressed everything @phrawzty Could you take another look?

@zippolyte zippolyte merged commit 1e50356 into master Feb 14, 2019
@zippolyte zippolyte deleted the nick/postfix_logs branch February 14, 2019 09:51
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