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 nginx ML module tutorial #3878

Merged
merged 6 commits into from
May 30, 2024

Conversation

mdbirnstiehl
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl commented May 9, 2024

This PR closes #3809.

Add a section in the nginx onboarding tutorial that shows users how to use built-in ML jobs to detect anomalies in their access logs.

@mdbirnstiehl mdbirnstiehl self-assigned this May 9, 2024
Copy link
Contributor

github-actions bot commented May 9, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented May 9, 2024

This pull request does not have a backport label. Could you fix it @mdbirnstiehl? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label May 9, 2024
@mdbirnstiehl mdbirnstiehl added backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels May 10, 2024
@mdbirnstiehl mdbirnstiehl marked this pull request as ready for review May 10, 2024 16:34
@mdbirnstiehl mdbirnstiehl requested a review from a team as a code owner May 10, 2024 16:34
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

Just some editorial suggestions.

docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx.asciidoc Outdated Show resolved Hide resolved
szabosteve
szabosteve previously approved these changes May 13, 2024
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

Left two tiny suggestions, please take or leave them. LGTM! 🎉

docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
@bmorelli25
Copy link
Member

Hi, @agithomas / @alex-fedotyev 👋 Can you please provide feedback on this PR when you have a second?

Copy link

@agithomas agithomas left a comment

Choose a reason for hiding this comment

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

This tutorial is going to be extremely useful.

Minor suggestions added.

docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
@agithomas
Copy link

agithomas commented May 29, 2024

@mdbirnstiehl , In here provides the configuration of ML jobs.

Are you considering including a section on how to create this configuration and the steps to follow to bundle them under an integration package?

@mdbirnstiehl
Copy link
Contributor Author

@mdbirnstiehl , In here provides the configuration of ML jobs.

Are you considering including a section on how to create this configuration and the steps to follow to bundle them under an integration package?

@agithomas Would this be an alternative to setting up the ML jobs in Kibana (this section in the tutorial)? Do you think this would provide value over the Kibana set up? I'm not familiar with the process, but would be happy to include it if you could provide some detail.

@agithomas
Copy link

@agithomas Would this be an alternative to setting up the ML jobs in Kibana (this section in the tutorial)? Do you think this would provide value over the Kibana set up? I'm not familiar with the process, but would be happy to include it if you could provide some detail.

Currently, we build dashboards for a specific integration in Kibana, Export them and make it as a part of a package (elastic-package exports dashboard). When the package is installed, the dashboard gets created.

When we decide to extend the ML jobs to other integration packages , similar to how it is done here , it will be useful for the integration developers.

If this can be facilitated through elastic-package (similar to the dashboard), it will be a greater convenience.

cc @jsoriano , @lalit-satapathy , @tommyers-elastic

@bmorelli25
Copy link
Member

Are you considering including a section on how to create this configuration and the steps to follow to bundle them under an integration package?

I don't want this addition to block this PR. Let's open a follow-up issue for that so we can merge this.

bmorelli25
bmorelli25 previously approved these changes May 30, 2024
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/monitor-nginx-ml.asciidoc Outdated Show resolved Hide resolved
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

🐦

@mdbirnstiehl mdbirnstiehl merged commit bc6d9b5 into elastic:main May 30, 2024
3 checks passed
@mdbirnstiehl mdbirnstiehl deleted the ml-nginx-onboarding branch May 30, 2024 20:53
mergify bot pushed a commit that referenced this pull request May 30, 2024
mergify bot pushed a commit that referenced this pull request May 30, 2024
mdbirnstiehl added a commit that referenced this pull request May 30, 2024
(cherry picked from commit bc6d9b5)

Co-authored-by: Mike Birnstiehl <[email protected]>
mdbirnstiehl added a commit that referenced this pull request May 30, 2024
(cherry picked from commit bc6d9b5)

Co-authored-by: Mike Birnstiehl <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Onboard NGINX using integrations - Machine Learning jobs
5 participants