[squid] Add dashboard, improve documentation, GA integration #11145
Conversation
- Improve the documentation of the integration - Add dashboard - Release integration as GA
taylor-swanson
added
enhancement
andrewkroh
added
the
dashboard
🚀 Benchmarks reportTo see the full report comment with |
💚 Build Succeeded
|
|
|
Pinging @elastic/sec-deployment-and-devices (Team:Security-Deployment and Devices) |
| @@ -1,11 +1,64 @@ | |||
| # Squid integration | |||
| # Squid Proxy | |||
There was a problem hiding this comment.
This _dev/build/docs/README.md looks like it's exactly the same as docs/README.md minus additional data in the latter.
Why is this the case? And is there something in place to ensure that if something in this one gets updated, that the docs/README.md one get updated, too?
There was a problem hiding this comment.
_dev/build/docs/README.md is the "template" version and docs/README.md is the "generated" version. We edit the template version. When you run elastic-package build, it will regenerate the docs/README.md file, bringing in field definitions and sample events as part of the process.
There is a CI check (done by elastic-package check if I'm not mistaken) that verifies you've done the build process and that you've checked-in the result.
| @@ -0,0 +1,2604 @@ | |||
| { | |||
| "attributes": { | |||
| "description": "Overview of Squid Proxy access log events", | |||
There was a problem hiding this comment.
Curious how this file is generated.
Do you create the dashboard in Kibana, and then do some sort of export?
I assume these files are rarely modified by hand, and instead overwritten by a newer version of the dashboard json?
There was a problem hiding this comment.
Yep, we create the dashboard in kibana and use elastic-package export dashboards to get the json files. Same applies for modifications.
| screenshots: | ||
| - src: /img/dashboard-1.png | ||
| title: Dashboard | ||
| size: 2432x2368 |
There was a problem hiding this comment.
Did you have to use a photo program to get the size here? Seems a bit odd that we have to specify the size. What happens if the size is wrong?
There was a problem hiding this comment.
To be honest, I don't think the size does anything. Neither does the type for that matter, as you can give the wrong mime type and it'll fine (in fact in some cases, giving the correct mime type will actually crash Kibana, but that's a separate issue). Regarding the size, most GUI shells (Finder, Windows Explorer) will show the image size in the properties of the file.
|
Package squid - 1.0.0 containing this change is available at https://epr.elastic.co/search?package=squid |
Proposed commit message
Checklist
changelog.ymlfile.How to test this PR locally
Related issues
Screenshots