Skip to content

[Swimlane] New integration - #13499

Merged
kcreddy merged 47 commits into
elastic:mainfrom
kevinmata92:swimlane-0.0.1
May 2, 2025
Merged

kcreddy merged 47 commits into
elastic:mainfrom
kevinmata92:swimlane-0.0.1

Conversation

@kevinmata92

Copy link
Copy Markdown
Contributor

Proposed commit message

Add initial Swimlane Turbine integration

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • Linting/Testing

How to test this PR locally

  1. Install Swimlane Turbine on-prem instance
  2. Setup integration in Kibana

Screenshots

swimlane-turbine-integration-config

@kevinmata92
kevinmata92 requested a review from a team as a code owner April 10, 2025 23:27
@cla-checker-service

cla-checker-service Bot commented Apr 10, 2025 •

Copy link
Copy Markdown

💚 CLA has been signed

@kevinmata92

Copy link
Copy Markdown
Contributor Author

I've signed the contributor agreement. Is there a way to re-run that job or is that done automatically?

@andrewkroh andrewkroh added the New Integration Issue or pull request for creating a new integration package. label Apr 11, 2025
@jamiehynds jamiehynds added the Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] label Apr 15, 2025
@elasticmachine

Copy link
Copy Markdown

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@jamiehynds
jamiehynds requested a review from a team April 15, 2025 10:18
Comment thread packages/swimlane/manifest.yml Outdated
Comment thread packages/swimlane/data_stream/swimlane_api/_dev/test/pipeline/test-events.json Outdated
Comment thread packages/swimlane/_dev/build/build.yml Outdated
Comment thread packages/swimlane/docs/README.md
Comment thread packages/swimlane/data_stream/tenant_api/_dev/test/pipeline/test-events.json Outdated
@kevinmata92

Copy link
Copy Markdown
Contributor Author

Thanks for the feedback @efd6. I'll work on making all these changes.

@kevinmata92
kevinmata92 requested a review from a team as a code owner April 17, 2025 23:45
@kcreddy

kcreddy commented Apr 19, 2025

Copy link
Copy Markdown
Contributor

/test

@kcreddy
kcreddy self-requested a review April 19, 2025 19:04
@kcreddy

kcreddy commented Apr 21, 2025 •

Copy link
Copy Markdown
Contributor

@kevinmata92, I'm taking over the re-review on this PR from @efd6 for the timebeing.
Looks like the current status of the CI is failing because of errors in pipeline tests (3 places):

pipeline test: test-events.log in swimlane.swimlane_api

test case failed: Expected results are different from actual ones: --- want
+++ got
@@ -28,16 +28,16 @@
             "message": "admin@domain.tld created a new permission",
             "source": {
                 "geo": {
-                    "city_name": "Hale",
+                    "city_name": "London",
                     "continent_name": "Europe",
                     "country_iso_code": "GB",
                     "country_name": "United Kingdom",
                     "location": {
-                        "lat": 51.6261,
-                        "lon": -0.2568
+                        "lat": 51.5142,
+                        "lon": -0.0931
                     },
-                    "region_iso_code": "GB-BNE",
-                    "region_name": "Barnet"
+                    "region_iso_code": "GB-ENG",
+                    "region_name": "England"
                 },
                 "ip": "81.2.69.144"
             },

Similar errors in 2 other places: pipeline test: test-events.log in swimlane.tenant_api, pipeline test: test-events.log in swimlane.turbine_api.
You will need to run pipeline tests using the stack version defined in the manifest.yml kibana.version property which seems to be 8.17.4. Can you run pipeline tests and commit the *-expected.json files?

That should fix the CI issue.

Once that is done, I can do a re-review.

@kevinmata92

Copy link
Copy Markdown
Contributor Author

@kcreddy appreciate you helping out, I've ran the test locally against 8.17.4 which we have an it is all passing. Now the odd part is that those files are the same as the ones above.

I ran both elastic-package test and also re-ran elastic-package test pipeline --generate, which did not generate any changes in those files.

--- Test results for package: swimlane - START ---
╭──────────┬──────────────┬───────────┬─────────────────┬────────┬──────────────╮
│ PACKAGE  │ DATA STREAM  │ TEST TYPE │ TEST NAME       │ RESULT │ TIME ELAPSED │
├──────────┼──────────────┼───────────┼─────────────────┼────────┼──────────────┤
│ swimlane │ swimlane_api │ pipeline  │ test-events.log │ PASS   │ 141.711334ms │
│ swimlane │ tenant_api   │ pipeline  │ test-events.log │ PASS   │ 141.237833ms │
│ swimlane │ turbine_api  │ pipeline  │ test-events.log │ PASS   │ 173.962583ms │
╰──────────┴──────────────┴───────────┴─────────────────┴────────┴──────────────╯
--- Test results for package: swimlane - END   ---
Done

Any thoughts on what to try next?

@kcreddy

kcreddy commented Apr 22, 2025 •

Copy link
Copy Markdown
Contributor

@kevinmata92, that is a bit weird.
I reran the pipeline tests after checking out your PR locally on 8.17.4 stack.
cd packages/swimlane && elastic-package stack down && elastic-package build && elastic-package stack up --version=8.17.4 -d -v && eval "$(elastic-package stack shellinit)" && elastic-package test pipeline --generate -v

This produced 3 changes:

Screenshot 2025-04-22 at 5 38 03 PM

Can you try above command and let me know if that works?

@kevinmata92

Copy link
Copy Markdown
Contributor Author

Adding the extra line of the test sample logs and that seemed to resolve the issue I was having. I made some additional updates and re-ran elastic-package test and everything passed. Thank you @efd6 @kcreddy for all the help!

@kevinmata92
kevinmata92 requested a review from efd6 April 30, 2025 20:17
@efd6

efd6 commented Apr 30, 2025

Copy link
Copy Markdown
Contributor

/test

@efd6 efd6 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looking good.

Comment thread packages/swimlane/data_stream/swimlane_api/_dev/test/pipeline/test-events.log Outdated
Comment thread packages/swimlane/data_stream/turbine_api/_dev/test/pipeline/test-events.log Outdated
Comment thread packages/swimlane/manifest.yml Outdated
Comment thread packages/swimlane/manifest.yml Outdated
Comment thread packages/swimlane/_dev/build/docs/README.md Outdated
@kevinmata92
kevinmata92 requested a review from efd6 May 1, 2025 15:30
@kevinmata92
kevinmata92 requested a review from efd6 May 1, 2025 22:18
@efd6

efd6 commented May 1, 2025

Copy link
Copy Markdown
Contributor

/test

@efd6

efd6 commented May 1, 2025

Copy link
Copy Markdown
Contributor

/test

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

@elastic-sonarqube

Copy link
Copy Markdown

@efd6 efd6 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, but waiting for @kcreddy

Thanks

@kcreddy kcreddy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. Thanks for the contribution 🏅

@kcreddy
kcreddy merged commit ce7c3da into elastic:main May 2, 2025
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package swimlane - 0.1.0 containing this change is available at https://epr.elastic.co/package/swimlane/0.1.0/

@kevinmata92

Copy link
Copy Markdown
Contributor Author

@kcreddy @efd6 Thank you both again for all the immense help on getting this published.

Is there any additional work to do to get this to appear under the integrations page in Elastic? I currently do not see it in our instance unless I am missing something.

Thanks in advance!

@efd6

efd6 commented May 7, 2025

Copy link
Copy Markdown
Contributor

@kevinmata92 No, this is done. You can see the package in EPR in the comment above. It is not yet GA (v1+), so to see it in the install integrations page in kibana, you will need to select the toggle to "Display beta integrations".

Screenshot from 2025-05-07 10-45-05

@kevinmata92

Copy link
Copy Markdown
Contributor Author

@efd6 Missed that toggle. Thank you Dan!

@kevinmata92
kevinmata92 deleted the swimlane-0.0.1 branch May 7, 2025 04:40
@andrewkroh andrewkroh added the Integration:swimlane Swimlane Turbine (Community supported) label May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Integration:swimlane Swimlane Turbine (Community supported) New Integration Issue or pull request for creating a new integration package. Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants