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

winlog: improve documentation for obtaining channel names #5689

Merged
merged 1 commit into from
Mar 28, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Mar 27, 2023

What does this PR do?

Improves documentation for obtaining channel names.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@elasticmachine
Copy link

elasticmachine commented Mar 27, 2023

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-03-27T04:01:11.918+0000

  • Duration: 15 min 18 sec

Test stats 🧪

Test Results
Failed 0
Passed 2
Skipped 0
Total 2

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@efd6 efd6 marked this pull request as ready for review March 27, 2023 04:08
@efd6 efd6 requested a review from a team as a code owner March 27, 2023 04:08
@elasticmachine
Copy link

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@efd6 efd6 requested a review from 111andre111 March 27, 2023 04:09
@elasticmachine
Copy link

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (0/0) 💚
Files 100.0% (0/0) 💚 2.23
Classes 100.0% (0/0) 💚 2.23
Methods 66.667% (2/3) 👎 -26.58
Lines 100.0% (0/0) 💚 6.878
Conditionals 100.0% (0/0) 💚

log channels by running `Get-EventLog *` in PowerShell. Custom ingest
pipelines may be added by setting one up in
[Ingest Node Pipelines](/app/management/ingest/ingest_pipelines/).
The custom Windows event log package allows you to ingest events from any [Windows event log](https://docs.microsoft.com/en-us/windows/win32/wes/windows-event-log) channel.

Choose a reason for hiding this comment

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

Just a quick question on that, should be documented as well that accepted channel names can contain spaces as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is that not well understood?

Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

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

LGTM.

@efd6 efd6 merged commit 4bb210d into elastic:main Mar 28, 2023
@elasticmachine
Copy link

Package winlog - 1.12.4 containing this change is available at https://epr.elastic.co/search?package=winlog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Winlog] Synchronize Winlog documentation with Winlogbeat about how to get Log channel names
4 participants