elastic / package-spec

EPR package specifications
Other
17 stars 70 forks source link

Add SLO assets to the package spec #767

Closed mgiota closed 2 months ago

mgiota commented 2 months ago

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

✔️ Acceptance criteria

mgiota commented 2 months ago

@jsoriano I open up this PR for review. Let me know what other changes I might need to do that I am not aware of. Thanks!

mgiota commented 2 months ago

test integrations

elasticmachine commented 2 months ago

Created or updated PR in integrations repository to test this version. Check https://github.com/elastic/integrations/pull/10231

mgiota commented 2 months ago

I was following the Contributing guide and I commented test integrations in this PR, but I am not sure why the auto generated PR is failing. Could you help me out here?

jsoriano commented 2 months ago

I am not sure why the auto generated PR is failing. Could you help me out here?

The failures there are not related to this change, no worries :slightly_smiling_face: aws package uses to be flaky, and azure_blob_storage has a known issue.

mgiota commented 2 months ago

To decide what version to use, the main question would be regarding the level of support in Kibana. If a package using this feature requires changes in Kibana to work properly

As far as I understand there will be some changes in the Fleet module in kibana to make the whole integration work. So I guess we should add the change into 3.3.0-next.

add a changelog entry

I found a couple of changelog files. Where exactly should we add the new SLO asset support? Or is the change you recommnded in the spec file enough?

mgiota commented 2 months ago

@jsoriano Now I am getting some validation errors:

found 1 validation error:
1. item [slo] is not allowed in folder [../../../../test/packages/good_v2/kibana]                              

Do I need to specify the new slo item anywhere else? The tests started failing after I committed the change with the patch version. So I guess I am missing something else as well.

jsoriano commented 2 months ago

Do I need to specify the new slo item anywhere else? The tests started failing after I committed the change with the patch version. So I guess I am missing something else as well.

The problem is that the good package uses an old version of the spec, and packages with SLOs will need to have at least a format_version equal or greater than 3.3.0.

I would recommend to move the test files you added to the good_v3 package and increase its format_version to 3.3.0.

You can run these tests locally for faster feedback, with go test ./... from the root directory of the repository.

elasticmachine commented 2 months ago

:green_heart: Build Succeeded

History

muthu-mps commented 2 months ago

@mgiota , @jsoriano - Just FYI, The directory structure we follow for the integrations to include SLO's and the general guidelines around using the ID's as name of the json file is still in discussion. We can continue those discussions in the issue. This may evolve going forward.

mgiota commented 2 months ago

@jsoriano Looks like I am not authorized to merge this PR. Could you either merge the PR or grant me access to merge it?

Screenshot 2024-06-25 at 14 57 19
ruflin commented 2 months ago

@mgiota Thank you for making this happen!!!