[Nginx] Add SLO's with Nginx Package #10269

muthu-mps · 2024-06-26T12:41:09Z

Fixes https://github.com/elastic/observability-dev/issues/3677

Enhancement

Adds new SLO to be shipped with the integration package.

Created a simple request includes the create_slo API request input.
This is the basic version to test the SLO's with the integration package. Subject to change.
Updated the package spec version in the integration to 3.3.0 (pre-release version) as suggested by @jsoriano

Package spec changes goes here.

muthu-mps · 2024-06-26T12:43:20Z

packages/nginx/manifest.yml

@@ -1,7 +1,7 @@
-format_version: "3.0.2"
+format_version: "3.3.0"


@jsoriano - I have updated the version to 3.3.0 to test the behaviour and I am getting this error.

Error: building package failed: invalid content found in built zip package: could not load specification for version [3.3.0]: spec version "3.3.0" not found

Can you suggest on how to test this change with the pre-release version?

No released version of package spec contains this spec version, you will need to add a replace in the meantime, something like this:

go mod edit -replace github.com/elastic/package-spec/v3=github.com/elastic/package-spec/v3@main go mod tidy

What is the format_version that we could use for testing the package?

What is the format_version that we could use for testing the package?

format_version: 3.3.0

@jsoriano - Tried the above step and with the format_version:3.3.0 we are still getting the same error.

Looks good, yes, this should be enough for CI.

If you want to use elastic-package locally with this dependency you can run it as go run github.com/elastic/elastic-package from the integrations repository.

Thanks @jsoriano!

We are getting few validation errors in different package, I am skipping those for now as those are not related.

Yeah, after updating go.mod all tests are executed, but you can ignore the ones not related to your package.

No released version of package spec contains this spec version

@jsoriano When is the next release of the package spec?

@jsoriano When is the next release of the package spec?

We release more or less on demand, and we have just released 3.2.1. Maybe we can release 3.2.2 soon with a couple of bugfixes. This release would also include 3.3.0 prerelease, what will allow to use SLOs in prerelease packages.

elasticmachine · 2024-06-27T08:08:24Z

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

mgiota · 2024-06-27T09:20:03Z

go.mod

@@ -208,3 +208,5 @@ require (
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )
+
+replace github.com/elastic/package-spec/v3 => github.com/elastic/package-spec/v3 v3.2.1-0.20240626070810-2758f3ed9689


@muthu-mps I just want to verify if this version is correct v3.2.1-0.20240626070810-2758f3ed9689

@jsoriano If I understand correctly, this addition is temporary? I mean once the next package-spec is released, do we still need this change? Maybe we should exclude this change from git and just rely on running go run github.com/elastic/elastic-package build locally to be able to test it?

@muthu-mps I just want to verify if this version is correct v3.2.1-0.20240626070810-2758f3ed9689

Yes, With this version I am able to build the integrations successfully by adding SLO's. That means it is using the package-spec change to add slo's.

@jsoriano If I understand correctly, this addition is temporary? I mean once the next package-spec is released, do we still need this change? Maybe we should exclude this change from git and just rely on running go run github.com/elastic/elastic-package build locally to be able to test it?

Yes, this is temporary to allow to run in CI till 3.3.0 is available. This PR cannot be merged till then.

This replace can be removed now, we have just released a version of elastic-package that includes the technical preview of 3.3.0.

mgiota · 2024-06-27T10:42:49Z

Changes LGTM! I leave a comment here, regarding updating the README file of the Ngnix integration to include the SLO asset addition.

packages/nginx/changelog.yml

Co-authored-by: Panagiota Mitsopoulou <giota85@gmail.com>

mgiota · 2024-06-27T11:05:08Z

I found similar commit, where ML modules were added to the README. I am adding it here for reference

mgiota · 2024-06-27T13:28:18Z

packages/nginx/_dev/build/docs/README.md

+## SLOs
+
+SLOs are usually defined in terms of metrics such as availability, response time, and throughput, and they are used to ensure that the service meets the needs of its users.
+You can use the Nginx integration to measure the availability of the Nginx service. The SLOs gets created automatically during the installation of the integration. The user can view the created SLOs in the Kibana dashboard panel.


@muthu-mps Nice! I took your changes and I was able to see the README changes in the UI!

I have one correction regarding this text in the Kibana dashboard panel. You should change that, since user can see the automatically generated SLOs under the Observability SLOs page.

I was checking the Kibana SLO documentation page and they reference the SLOs page page like this Observability -> SLOs.

So feel free to change to: The user can view the created SLOs in the Observability -> SLOs page.

Thanks! I have updated the README file.

harnish-elastic

As per offline discussion, need to update the following things!

Need to use index logs-* instead of logs-nginx-*
Need to add data_stream.dataset query since the field that has been used is ecs and if the user having multiple packages, SLO/alerts will also be generated from that field!

muthu-mps · 2024-07-24T07:28:41Z

As per offline discussion, need to update the following things!

Need to use index logs-* instead of logs-nginx-*

Need to add data_stream.dataset query since the field that has been used is ecs and if the user having multiple packages, SLO/alerts will also be generated from that field!

Yes Harnish, The issue here is that the default dataview is only supported here. I have already captured it here.

elasticmachine · 2024-07-24T09:01:30Z

💚 Build Succeeded

Buildkite Build
Commit: d1ba630

History

💚 Build #13904 succeeded 4ecfa70
💔 Build #13903 failed 2f311c8
💔 Build #12963 failed 9c32379
💔 Build #12962 failed 0603c97
💔 Build #12956 failed d84e352
💔 Build #12943 failed 029e7e5

elastic-sonarqube · 2024-07-24T09:01:33Z

Quality Gate failed

Failed conditions
5.3% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube

botelastic · 2024-09-18T20:38:02Z

Hi! We just realized that we haven't looked into this PR in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!

botelastic · 2024-10-18T21:29:27Z

Hi! This PR has been stale for a while and we're going to close it as part of our cleanup procedure. We appreciate your contribution and would like to apologize if we have not been able to review it, due to the current heavy load of the team. Feel free to re-open this PR if you think it should stay open and is worth rebasing. Thank you for your contribution!

add slos to nginx integration

fc23f39

muthu-mps commented Jun 26, 2024

View reviewed changes

muthu-mps added 4 commits June 27, 2024 09:15

skipping validation errors

68f1f18

replace package-spec version

ac5e390

fix CI error

30161fe

revert blob store error

029e7e5

mgiota reviewed Jun 27, 2024

View reviewed changes

packages/nginx/changelog.yml Outdated Show resolved Hide resolved

mgiota requested changes Jun 27, 2024

View reviewed changes

packages/nginx/changelog.yml Outdated Show resolved Hide resolved

Update packages/nginx/changelog.yml

d84e352

Co-authored-by: Panagiota Mitsopoulou <giota85@gmail.com>

mgiota mentioned this pull request Jun 27, 2024

[SLOs][Fleet] Install integration SLO assets elastic/kibana#186974

Open

muthu-mps added 2 commits June 27, 2024 18:30

Add SLO section in the README

031df18

Merge branch 'add_slo' of github.com:muthu-mps/integrations into add_slo

0603c97

mgiota reviewed Jun 27, 2024

View reviewed changes

address review comments

9c32379

muthu-mps mentioned this pull request Jul 19, 2024

[SLO] POC SLOs with Nginx Integration #10467

Closed

andrewkroh added Integration:nginx Nginx Team:Obs-InfraObs Label for the Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Jul 19, 2024

muthu-mps added 2 commits July 24, 2024 12:44

update dataview

2f311c8

resolve conflicts

4ecfa70

harnish-elastic self-requested a review July 24, 2024 07:22

harnish-elastic requested changes Jul 24, 2024

View reviewed changes

filter nginx log data

d1ba630

andrewkroh added the enhancement New feature or request label Aug 19, 2024

botelastic bot added the Stalled label Sep 18, 2024

botelastic bot closed this Oct 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Nginx] Add SLO's with Nginx Package #10269

[Nginx] Add SLO's with Nginx Package #10269

muthu-mps commented Jun 26, 2024 •

edited by mgiota

Loading

muthu-mps Jun 26, 2024

jsoriano Jun 26, 2024

muthu-mps Jun 26, 2024

jsoriano Jun 26, 2024

muthu-mps Jun 26, 2024

jsoriano Jun 26, 2024 •

edited

Loading

muthu-mps Jun 27, 2024

jsoriano Jun 27, 2024

mgiota Jun 27, 2024

jsoriano Jun 27, 2024

elasticmachine commented Jun 27, 2024 •

edited

Loading

mgiota Jun 27, 2024 •

edited

Loading

mgiota Jun 27, 2024 •

edited

Loading

muthu-mps Jun 27, 2024

jsoriano Jun 27, 2024

jsoriano Jul 4, 2024

mgiota commented Jun 27, 2024

mgiota commented Jun 27, 2024

mgiota Jun 27, 2024

muthu-mps Jun 27, 2024

harnish-elastic left a comment •

edited

Loading

muthu-mps commented Jul 24, 2024

elasticmachine commented Jul 24, 2024

elastic-sonarqube bot commented Jul 24, 2024

botelastic bot commented Sep 18, 2024

botelastic bot commented Oct 18, 2024

		@@ -1,7 +1,7 @@
		format_version: "3.0.2"
		format_version: "3.3.0"

[Nginx] Add SLO's with Nginx Package #10269

[Nginx] Add SLO's with Nginx Package #10269

Conversation

muthu-mps commented Jun 26, 2024 • edited by mgiota Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoriano Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jun 27, 2024 • edited Loading

🚀 Benchmarks report

mgiota Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

mgiota Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgiota commented Jun 27, 2024

mgiota commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harnish-elastic left a comment • edited Loading

Choose a reason for hiding this comment

muthu-mps commented Jul 24, 2024

elasticmachine commented Jul 24, 2024

💚 Build Succeeded

History

elastic-sonarqube bot commented Jul 24, 2024

Quality Gate failed

botelastic bot commented Sep 18, 2024

botelastic bot commented Oct 18, 2024

muthu-mps commented Jun 26, 2024 •

edited by mgiota

Loading

jsoriano Jun 26, 2024 •

edited

Loading

elasticmachine commented Jun 27, 2024 •

edited

Loading

mgiota Jun 27, 2024 •

edited

Loading

mgiota Jun 27, 2024 •

edited

Loading

harnish-elastic left a comment •

edited

Loading