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

[Stack Monitoring] Readme for kibana module #31276

Merged
merged 1 commit into from
Apr 14, 2022
Merged

[Stack Monitoring] Readme for kibana module #31276

merged 1 commit into from
Apr 14, 2022

Conversation

matschaffer
Copy link
Contributor

What does this PR do?

Provides a basic overview document for the kibana metricbeat module

Why is it important?

So new developers can have a basic understanding of what the module does and how it works.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • What endpoints does Metricbeat request data from, and what data is requested?
  • Of the data we request, what gets stored in the ES indices? Do we have a description of each field anywhere? What is the source of truth?

Stretch:

  • Of the documents and fields that we store, how many are queried by the Kibana app? How many are never queried?
  • Of the documents and fields queried, which are used for which graphs and charts and tables etc in the UI?

How to test this PR locally

N/A

Related issues

Use cases

N/A

Screenshots

N/A

Logs

N/A

@matschaffer matschaffer added docs Feature:Stack Monitoring Team:Infra Monitoring UI - DEPRECATED Infrastructure Monitoring UI team - DEPRECATED - Use Team:Monitoring labels Apr 13, 2022
@matschaffer matschaffer requested a review from a team as a code owner April 13, 2022 07:50
@matschaffer matschaffer self-assigned this Apr 13, 2022
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Apr 13, 2022
@elasticmachine
Copy link
Collaborator

💚 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: 2022-04-13T07:50:42.641+0000

  • Duration: 18 min 27 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

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

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

miltonhultgren
miltonhultgren approved these changes Apr 14, 2022
View reviewed changes
Copy link
Contributor

@miltonhultgren miltonhultgren left a comment

Choose a reason for hiding this comment

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

Looks mostly good to me, I could nitpick about consistent capitalization of Kibana and such but for internal dev docs it's fine to merge :)

@matschaffer matschaffer merged commit f1ce912 into elastic:main Apr 14, 2022
v1v added a commit to v1v/beats that referenced this pull request Apr 18, 2022
@v1v
Merge remote-tracking branch 'upstream/main' into feature/rename-dock…
eda0443 
…er-tar-gz

* upstream/main: (139 commits)
  [Automation] Update elastic stack version to 8.3.0-c655cda8 for testing (elastic#31322)
  Define a queue metrics reporter interface  (elastic#31289)
  [Oracle Module] Change tablespace metricset collection period (elastic#31259)
  libbeat/reader/syslog: relax timestamp parsing to allow leading zero (elastic#31254)
  [Automation] Update elastic stack version to 8.3.0-55ba6f37 for testing (elastic#31311)
  [libbeat] Remove unused fields and functions in the memory queue (elastic#31302)
  [libbeat] Cleaning up some unneeded helper types (elastic#31290)
  Readme for kibana module (elastic#31276)
  [Automation] Update elastic stack version to 8.3.0-4be61f32 for testing (elastic#31296)
  x-pack/winlogbeat/module/routing/ingest: fix typo for channel name (elastic#31291)
  Small pipeline cleanup removing some unused data fields (elastic#31288)
  removing info log (elastic#30971)
  Simplify TLS config deserialization (elastic#31168)
  Detect new files under known paths in filestream input (elastic#31268)
  Add support for port mapping in docker hints (elastic#31243)
  Update qa-labels.yml (elastic#31260)
  libbeat: log debug for `proxy_url` and fixed docs (elastic#31130)
  [heartbeat][docs] Add note about ensuring correct index settings for uptime (elastic#31146)
  [Automation] Update elastic stack version to 8.3.0-2c8f9574 for testing (elastic#31256)
  [Filebeat] fix m365_defender pipeline bug (elastic#31227)
  ...
kush-elastic pushed a commit to kush-elastic/beats that referenced this pull request May 2, 2022
@matschaffer @kush-elastic
Readme for kibana module (elastic#31276)
8b73acf
chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023
@matschaffer @chrisberkhout
Readme for kibana module (#31276)
87376c3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@miltonhultgren miltonhultgren miltonhultgren approved these changes

Assignees

@matschaffer matschaffer

Labels
docs Feature:Stack Monitoring Team:Infra Monitoring UI - DEPRECATED Infrastructure Monitoring UI team - DEPRECATED - Use Team:Monitoring
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Stack Monitoring] Document data stored for Kibana module
3 participants
@matschaffer @elasticmachine @miltonhultgren