Dashboard guidelines: use by value

[endorama]

What does this PR do?

• move dashboard guidelines to separate file
• add guideline around visualisation by value

Updating guidelines to reflect the guideline to use visualisations by value is part of #3448.
I went a step forward and also moved dashboard guidelines to a new file, to help discovery and clarity of content.

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.

Author's Checklist

• [ ]

How to test this PR locally

Related issues

Screenshots

[elasticmachine]

💔 Tests Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2023-01-17T10:58:04.896+0000

• Duration: 116 min 7 sec

Test stats 🧪

Test	Results
Failed	5
Passed	4555
Skipped	10
Total	4570

Test errors

Expand to view the tests failures

Check integrations / system / system: check / pipeline test: test-multiline.log – system.auth

Expand to view the error details

 null 

Expand to view the stacktrace

 test case failed: Expected results are different from actual ones: --- want
+++ got
@@ -1,7 +1,7 @@
 {
     "expected": [
         {
-            "@timestamp": "2022-05-21T21:54:44.000Z",
+            "@timestamp": "2023-05-21T21:54:44.000Z",
             "ecs": {
                 "version": "8.0.0"
             },
@@ -27,7 +27,7 @@
             }
         },
         {
-            "@timestamp": "2022-05-21T21:54:45.000Z",
+            "@timestamp": "2023-05-21T21:54:45.000Z",
             "ecs": {
                 "version": "8.0.0"
             },
 

Check integrations / haproxy / haproxy: check / pipeline test: test-default.log – haproxy.log

Expand to view the error details

 null 

Expand to view the stacktrace

 test case failed: Expected results are different from actual ones: --- want
+++ got
@@ -1,7 +1,7 @@
 {
     "expected": [
         {
-            "@timestamp": "2022-09-20T15:42:59.000Z",
+            "@timestamp": "2023-09-20T15:42:59.000Z",
             "destination": {
                 "ip": "67.43.156.13",
                 "port": 5000
 

Check integrations / beat / beat: check / system test: default (variant: apm_8.7.0) – beat.stats

Expand to view the error details

 null 

Expand to view the stacktrace

 one or more errors found in documents stored in metrics-beats.stack_monitoring.stats-ep data stream: [0] field "beat.stats.apm_server.agentcfg.elasticsearch.cache.entries.count" is undefined
[1] field "beat.stats.apm_server.agentcfg.elasticsearch.cache.refresh.failures" is undefined
[2] field "beat.stats.apm_server.agentcfg.elasticsearch.cache.refresh.successes" is undefined
[3] field "beat.stats.apm_server.agentcfg.elasticsearch.fetch.es" is undefined
[4] field "beat.stats.apm_server.agentcfg.elasticsearch.fetch.fallback" is undefined
[5] field "beat.stats.apm_server.agentcfg.elasticsearch.fetch.invalid" is undefined
[6] field "beat.stats.apm_server.agentcfg.elasticsearch.fetch.unavailable" is undefined 

Check integrations / hadoop / hadoop: check / pipeline test: test-application-metrics.log – hadoop.application

Expand to view the error details

 null 

Expand to view the stacktrace

 test case failed: Expected results are different from actual ones: --- want
+++ got
@@ -23,8 +23,8 @@
                     "running_containers": -1,
                     "time": {
                         "elapsed": 35114,
-                        "finished": "2022-01-01T00:00:00.258Z",
-                        "started": "2022-01-01T00:00:00.144Z"
+                        "finished": "2023-01-01T00:00:00.258Z",
+                        "started": "2023-01-01T00:00:00.144Z"
                     },
                     "vcore_seconds": 57
                 }
@@ -56,8 +56,8 @@
                     "running_containers": -1,
                     "time": {
                         "elapsed": 9925,
-                        "finished": "2022-01-01T00:00:00.835Z",
-                        "started": "2022-01-01T00:00:00.910Z"
+                        "finished": "2023-01-01T00:00:00.835Z",
+                        "started": "2023-01-01T00:00:00.910Z"
                     },
                     "vcore_seconds": 7
                 }
 

Check integrations / hadoop / hadoop: check / pipeline test: test-datanode-metrics.json – hadoop.datanode

Expand to view the error details

 null 

Expand to view the stacktrace

 test case failed: Expected results are different from actual ones: --- want
+++ got
@@ -29,7 +29,7 @@
                         "remaining": 15825682432
                     },
                     "estimated_capacity_lost_total": 0,
-                    "last_volume_failure_date": "2022-01-01T00:00:00.000Z",
+                    "last_volume_failure_date": "2023-01-01T00:00:00.000Z",
                     "volumes": {
                         "failed": 0
                     }
 

Steps errors

Expand to view the steps failures

Test integration: beat

• Took 3 min 10 sec . View more details here
• Description: eval "$(../../build/elastic-package stack shellinit)" ../../build/elastic-package test -v --report-format xUnit --report-output file --test-coverage

Test integration: elasticsearch

• Took 22 min 5 sec . View more details here
• Description: eval "$(../../build/elastic-package stack shellinit)" ../../build/elastic-package test -v --report-format xUnit --report-output file --test-coverage

Take down the Elastic stack

• Took 0 min 19 sec . View more details here
• Description: build/elastic-package stack down -v

Test integration: hadoop

• Took 8 min 57 sec . View more details here
• Description: eval "$(../../build/elastic-package stack shellinit)" ../../build/elastic-package test -v --report-format xUnit --report-output file --test-coverage

Test integration: haproxy

• Took 3 min 51 sec . View more details here
• Description: eval "$(../../build/elastic-package stack shellinit)" ../../build/elastic-package test -v --report-format xUnit --report-output file --test-coverage

Test integration: system

• Took 2 min 14 sec . View more details here
• Description: eval "$(../../build/elastic-package stack shellinit)" ../../build/elastic-package test -v --report-format xUnit --report-output file --test-coverage

Boot up the Elastic stack

• Took 2 min 41 sec . View more details here
• Description: ../../build/elastic-package stack up -d -v --version 8.0.0

Google Storage Download

• Took 0 min 0 sec . View more details here

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

• /test : Re-trigger the build.

[elasticmachine]

🌐 Coverage report

Name	Metrics % (covered/total)	Diff
Packages	100.0% (362/362)	💚
Files	97.76% (611/625)	👎 -2.24
Classes	97.76% (611/625)	👎 -2.24
Methods	91.816% (5957/6488)	👍 0.907
Lines	91.846% (126275/137486)	👍 3.166
Conditionals	100.0% (0/0)	💚

[jlind23]

Thanks for the work.

[endorama]

@jlind23 I can't merge with failing CI. I don't think is related with my changes, maybe you have the right to merge this? Otherwise let me know how to proceed.

[jlind23]

@endorama Let me by pass checks for once.

[endorama]

Thanks!