Add stan package #532

ChrsMark · 2021-01-14T15:42:26Z

What does this PR do?

This PR adds stan metricset.

Still need to add a dashboard for log datastream.

Checklist

I have reviewed tips for building integrations and this pull request is aligned with them.
I have verified that all datasets collect metrics or logs.

How to test this PR locally

Test the service manually using elastic-package:

follow the instructions at https://github.com/elastic/elastic-package/blob/master/docs/howto/connect_service_with_elastic_stack.md#howto-connect-the-service-with-the-elastic-stack start a sample stan service.
Install the stan integration from kibana. Use /tmp/service_logs/stan.log* for logs and elastic-package-service_stan_1:8222 for metrics.
Verify that data are flowing for all datastreams and dashboards are working properly.

Related issues

Closes Create stan package #363

Screenshots

Signed-off-by: ChrsMark <[email protected]>

elasticmachine · 2021-01-14T15:52:44Z

💚 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

Build Cause: Pull request #532 updated
- Start Time: 2021-01-18T15:19:14.386+0000
Duration: 11 min 40 sec
Commit: f200279

Test stats 🧪

Test	Results
Failed	0
Passed	23
Skipped	0
Total	23

Signed-off-by: ChrsMark <[email protected]>

mtojek

Could you please rebase it against the master branch? I pushed a new test runner for checking presence of package assets. It will verify if the package can be installed.

mtojek

Great, all tests are passing including assets: https://beats-ci.elastic.co/blue/organizations/jenkins/Ingest-manager%2Fintegrations/detail/PR-532/13/tests

I left some comments.

mtojek · 2021-01-18T14:44:16Z

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

+
+## Compatibility
+
+The STAN package is tested with Stan 0.15.1


nit: missing dot at the end

mtojek · 2021-01-18T14:45:23Z

packages/stan/_dev/deploy/docker/Dockerfile

+FROM golang:1.13-alpine3.11 AS build-env
+RUN apk --no-cache add build-base git mercurial gcc
+RUN cd src && go get -d github.com/nats-io/stan.go/
+RUN cd src/github.com/nats-io/stan.go/examples/stan-bench && git checkout tags/v0.5.2 && go build .


nit: I wonder if there isn't a prebuilt image for this, but let's leave it if there isn't

Didn't find anything with a quick search maintained by NATS project and I would avoid using a random third party custom image (if any) so better to handle it on our own. In the future these images will be cached, no?

SGTM! We'll cache image when it becomes the problem. So far image building doesn't take much time.

mtojek · 2021-01-18T14:47:33Z

packages/stan/_dev/deploy/docker/run.sh

+#while true; do /stan-bench -np 10 -ns 10 -n 1000000000 -ms 1024 bar; done &
+
+# Make sure the container keeps running
+tail -f /dev/null


is this line necessary considering the while true above?

mtojek · 2021-01-18T14:49:53Z

packages/stan/kibana/visualization/stan-c3d1ab80-41a8-11e9-a4da-b1df688edbcd.json

+                    }
+                ]
+            },
+            "title": " Bytes Timeline [Logs STAN]",


nit: unnecessary space

mtojek · 2021-01-18T14:50:48Z

packages/stan/kibana/visualization/stan-c3d1ab80-41a8-11e9-a4da-b1df688edbcd.json

+                }
+            }
+        },
+        "title": " Bytes Timeline [Logs STAN]",


nit: actually this pattern is repeated in few places:

"title": "<space>

mtojek · 2021-01-18T14:51:40Z

packages/stan/manifest.yml

+  kibana.version: ">=7.11.0"
+screenshots:
+  - src: /img/metricbeat-stan-overview.png
+    title: Metricbeat STAN Dashboard


mtojek · 2021-01-18T14:51:52Z

packages/stan/manifest.yml

+    size: 1829x447
+    type: image/png
+  - src: /img/filebeat-stan-overview.png
+    title: Filebeat STAN Dashboard


Logs, not filebeat

Signed-off-by: ChrsMark <[email protected]>

mtojek

Please wait for green. If it passes, fee free to merge this PR. LGTM!

mtojek · 2021-01-18T15:15:45Z

packages/stan/manifest.yml

@@ -17,11 +17,11 @@ conditions:
  kibana.version: ">=7.11.0"
 screenshots:
  - src: /img/metricbeat-stan-overview.png


nit: I think you can fix filenames too.

Signed-off-by: ChrsMark <[email protected]>

ChrsMark added 4 commits January 13, 2021 17:17

Add stan package

90aa105

Signed-off-by: ChrsMark <[email protected]>

wip

9f73f66

Signed-off-by: ChrsMark <[email protected]>

lint

6b64515

Signed-off-by: ChrsMark <[email protected]>

Add ecs fields

9983f80

Signed-off-by: ChrsMark <[email protected]>

ChrsMark self-assigned this Jan 14, 2021

ChrsMark added enhancement New feature or request Integration:stan STAN labels Jan 14, 2021

ChrsMark added 7 commits January 15, 2021 10:20

Format pkg

c54d25b

Signed-off-by: ChrsMark <[email protected]>

fix log datastream

3cd99fd

Signed-off-by: ChrsMark <[email protected]>

Add expected file

7ab33d0

Signed-off-by: ChrsMark <[email protected]>

Fix log

2e51333

Signed-off-by: ChrsMark <[email protected]>

Add wip dashboard

ecef253

Signed-off-by: ChrsMark <[email protected]>

final fixups

031585d

Signed-off-by: ChrsMark <[email protected]>

fix service script

cd460b7

Signed-off-by: ChrsMark <[email protected]>

ChrsMark mentioned this pull request Jan 18, 2021

Add streaming category elastic/package-registry#671

Closed

ChrsMark marked this pull request as ready for review January 18, 2021 14:22

move to beta

f4652e3

Signed-off-by: ChrsMark <[email protected]>

mtojek self-requested a review January 18, 2021 14:25

mtojek reviewed Jan 18, 2021

View reviewed changes

Merge remote-tracking branch 'upstream/master' into add_stan_package

4c30f5f

mtojek self-requested a review January 18, 2021 14:53

mtojek reviewed Jan 18, 2021

View reviewed changes

review changes

215b0fc

Signed-off-by: ChrsMark <[email protected]>

mtojek approved these changes Jan 18, 2021

View reviewed changes

fix file names

f200279

Signed-off-by: ChrsMark <[email protected]>

ChrsMark merged commit 23434d0 into elastic:master Jan 18, 2021

ChrsMark mentioned this pull request Jan 19, 2021

Add missing datastream filters #539

Merged

eyalkraft pushed a commit to build-security/integrations that referenced this pull request Mar 30, 2022

Add stan package (elastic#532)

cf313c2

andrewkroh added the New Integration Issue or pull request for creating a new integration package. label Aug 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add stan package #532

Add stan package #532

ChrsMark commented Jan 14, 2021 •

edited

Loading

elasticmachine commented Jan 14, 2021 •

edited

Loading

Build stats

Test stats 🧪

mtojek left a comment

mtojek left a comment

mtojek Jan 18, 2021

mtojek Jan 18, 2021

ChrsMark Jan 18, 2021

mtojek Jan 18, 2021

mtojek Jan 18, 2021

mtojek Jan 18, 2021

mtojek Jan 18, 2021

mtojek Jan 18, 2021

mtojek Jan 18, 2021

mtojek left a comment

mtojek Jan 18, 2021

Add stan package #532

Add stan package #532

Conversation

ChrsMark commented Jan 14, 2021 • edited Loading

What does this PR do?

Checklist

How to test this PR locally

Related issues

Screenshots

elasticmachine commented Jan 14, 2021 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

mtojek left a comment

Choose a reason for hiding this comment

mtojek left a 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

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

Choose a reason for hiding this comment

mtojek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChrsMark commented Jan 14, 2021 •

edited

Loading

elasticmachine commented Jan 14, 2021 •

edited

Loading