[Filebeat] Add /inputs/ route for Filebeat input metrics #33859

andrewkroh · 2022-11-29T03:28:14Z

What does this PR do?

Expose metrics from Filebeat inputs under /inputs/. This moves metrics for aws-s3, aws-cloudwatch, cel, and lumberjack that were previously registered under the "dataset" monitoring namespace to the "inputs" namespace.

/inputs/ returns metrics related to input instances. It returns a list of objects where each object contains metrics for an instance of an input. Each object will minimally contain an input field that identifies the type of input (e.g. aws-s3) and an id field that is the unique identifier for the input instance.

A request may optionally specify a type query parameter to request metrics for a specific type of input. And pretty may be included to have the returned JSON be pretty formatted.

Why is it important?

This will establish a means of fetching input metrics. I plan to add a way to monitor this endpoint and create some dashboards.

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.

botelastic · 2022-11-29T03:28:19Z

This pull request doesn't have a Team:<team> label.

mergify · 2022-11-29T03:28:49Z

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @andrewkroh? 🙏.
For such, you'll need to label your PR with:

The upcoming major version of the Elastic Stack
The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

elasticmachine · 2022-11-29T04:42:28Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-12-06T17:16:29.626+0000
Duration: 181 min 49 sec

Test stats 🧪

Test	Results
Failed	0
Passed	27592
Skipped	2127
Total	29719

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the 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!)

Expose metrics from Filebeat inputs under /inputs/. This moves metrics for aws-s3, aws-cloudwatch, cel, and lumberjack that were previously registered under the "dataset" monitoring namespace to the "inputs" namespace. `/inputs/` returns metrics related to input instances. It returns a list of objects where each object contains metrics for an instance of an input. Each object will minimally contain an `input` field that identifies the type of input (e.g. `aws-s3`) and an `id` field that is the unique identifier for the input instance. A request may optionally specify a `type` query parameter to request metrics for a specific type of input. And `pretty` may be included to have the returned JSON be pretty formatted.

mergify · 2022-12-01T19:26:16Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b feature/filebeat/inputs-api upstream/feature/filebeat/inputs-api
git merge upstream/main
git push upstream feature/filebeat/inputs-api

belimawr

LGTM, I added some small comments/suggestions.

The questions about parameter case and if we need to be that strict are my main concerns here.

libbeat/monitoring/inputmon/httphandler.go

libbeat/monitoring/inputmon/httphandler_test.go

libbeat/monitoring/inputmon/httphandler.go

…uts-api

sonarqubecloud · 2022-12-06T17:26:47Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
2.4% Duplication

ruflin · 2023-01-04T10:06:22Z

CHANGELOG.next.asciidoc

@@ -16,6 +16,8 @@ https://github.com/elastic/beats/compare/v8.2.0\...main[Check the HEAD diff]

 *Filebeat*

+- Fixed error spam from `add_kubernetes_metadata` processor when running on AKS. {pull}33697[33697]
+- Metrics hosted by the HTTP monitoring endpoint for the `aws-cloudwatch`, `aws-s3`, `cel`, and `lumberjack` inputs are now available under `/inputs/` instead of `/dataset`.


Is this a potential breaking change?

Expose metrics from Filebeat inputs under /inputs/. This moves metrics for aws-s3, aws-cloudwatch, cel, and lumberjack that were previously registered under the "dataset" monitoring namespace to the "inputs" namespace. `/inputs/` returns metrics related to input instances. It returns a list of objects where each object contains metrics for an instance of an input. Each object will minimally contain an `input` field that identifies the type of input (e.g. `aws-s3`) and an `id` field that is the unique identifier for the input instance. A request may optionally specify a `type` query parameter to request metrics for a specific type of input. And `pretty` may be included to have the returned JSON be pretty formatted.

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Nov 29, 2022

andrewkroh marked this pull request as ready for review November 29, 2022 03:28

andrewkroh requested review from a team as code owners November 29, 2022 03:28

andrewkroh requested review from cmacknz and fearful-symmetry and removed request for a team November 29, 2022 03:28

mergify bot assigned andrewkroh Nov 29, 2022

andrewkroh marked this pull request as draft November 29, 2022 03:49

cmacknz requested a review from belimawr November 29, 2022 15:22

andrewkroh force-pushed the feature/filebeat/inputs-api branch from 46e12c9 to a4f043e Compare November 29, 2022 17:56

andrewkroh marked this pull request as ready for review November 29, 2022 19:09

belimawr reviewed Dec 5, 2022

View reviewed changes

andrewkroh mentioned this pull request Dec 6, 2022

[Metricbeat] beat module - add metricset for input metrics #33953

Closed

andrewkroh added 3 commits December 6, 2022 11:43

Use http.Error instead of serveError

3446c17

Make ?type queries case-insensitive

13a6fb1

Use context.Background() instead of TODO()

1bc1ecc

andrewkroh requested a review from belimawr December 6, 2022 17:15

Merge remote-tracking branch 'elastic/main' into feature/filebeat/inp…

c78025f

…uts-api

belimawr approved these changes Dec 8, 2022

View reviewed changes

andrewkroh merged commit 9249566 into elastic:main Dec 8, 2022

andrewkroh added the backport-skip Skip notification from the automated backport with mergify label Dec 8, 2022

ruflin reviewed Jan 4, 2023

View reviewed changes

kcreddy mentioned this pull request Jan 23, 2023

[Elastic Agent] Monitor Filebeat Inputs elastic/integrations#5077

Merged

4 tasks

This was referenced Mar 21, 2023

libbeat/monitoring/inputmon - Ignore dataset metrics without name and id #34884

Merged

[libbeat] Register missing /debug/pprof/ routes in beat HTTP API server #34913

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Filebeat] Add /inputs/ route for Filebeat input metrics #33859

[Filebeat] Add /inputs/ route for Filebeat input metrics #33859

andrewkroh commented Nov 29, 2022

botelastic bot commented Nov 29, 2022

mergify bot commented Nov 29, 2022

elasticmachine commented Nov 29, 2022 •

edited by jenkins-beats-ci bot

Loading

Build stats

Test stats 🧪

mergify bot commented Dec 1, 2022

belimawr left a comment

sonarqubecloud bot commented Dec 6, 2022

ruflin Jan 4, 2023

[Filebeat] Add /inputs/ route for Filebeat input metrics #33859

[Filebeat] Add /inputs/ route for Filebeat input metrics #33859

Conversation

andrewkroh commented Nov 29, 2022

What does this PR do?

Why is it important?

Checklist

botelastic bot commented Nov 29, 2022

mergify bot commented Nov 29, 2022

elasticmachine commented Nov 29, 2022 • edited by jenkins-beats-ci bot Loading

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

mergify bot commented Dec 1, 2022

belimawr left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 6, 2022

ruflin Jan 4, 2023

Choose a reason for hiding this comment

elasticmachine commented Nov 29, 2022 •

edited by jenkins-beats-ci bot

Loading