[mdatagen] [receiver/hostmetrics] Show warnings defined in metadata.yaml

[dmitryax]

This change adds a metadata.yaml option to specify a warning that will be shown in case the metric is enabled.

The new option is used to notify a user about recently deprecated process.memory.physical_usage and process.memory.virtual_usage metrics emitted by hostmetrics receiver. Look at receiver/hostmetricsreceiver/internal/scraper/processscraper/metadata.yaml how it's being applied.

[dmitryax]

@astencel-sumo PTAL

[andrzej-stencel]

Thanks @dmitryax. If I understand correctly, this feature takes care of the warnings specified here:

• point 1. of Removing a default metric:

  Show a warning that the metric will be removed if the enabled option is not explicitly set to false in user settings.

• point 2. of Removing a default metric:

  Make the metric optional. Show a warning that the metric will be removed if the enabled option is set to true in user settings.

• point 1. of Removing an optional metric:

  Show a warning that the metric will be removed if the enabled option is set explicitly to true in user settings.

I suppose the other warnings described are not in scope of this change, is my understanding correct?

• step 1 of Making a default metric optional:

  Add a warning that the metric will be turned into optional if enabled field is not set explicitly to any value in user settings.

• step 1. of Adding a new default metric or turning an existing optional metric into default:

  Add a warning that the metric will be turned into default if the enabled option is not set explicitly to any value in user settings.

[dmitryax]

I suppose the other warnings described are not in scope of this change, is my understanding correct?

Yes, I'll handle those separately. Goal of this PR is to solve the immediate need for the process scraper

[runforesight]

Foresight Summary

    
Major Impacts

TestFinder ❌ failed 2 times in 6 runs (33% fail rate).

TestFinder/DoubleStarSameDepth ❌ failed 2 times in 6 runs (33% fail rate).

TestFinder/DoubleStarVaryingDepth ❌ failed 2 times in 6 runs (33% fail rate).

TestFinder/Exclude ❌ failed 2 times in 6 runs (33% fail rate).

TestFinder/ExcludeDuplicates ❌ failed 2 times in 6 runs (33% fail rate).

build-and-test duration(43 minutes 49 seconds) has decreased 20 minutes 25 seconds compared to main branch avg(1 hour 4 minutes 14 seconds).

View More Details

✅  check-links workflow has finished in 38 seconds (2 minutes 16 seconds less than main branch avg.) and finished at 6th Dec, 2022.

---

Job	Failed Steps	Tests
changed files	-     🔗	N/A	See Details
check-links	-     🔗	N/A	See Details

---

✅  tracegen workflow has finished in 1 minute 10 seconds (2 minutes 11 seconds less than main branch avg.) and finished at 6th Dec, 2022.

---

Job	Failed Steps	Tests
build-dev	-     🔗	N/A	See Details
publish-latest	-     🔗	N/A	See Details
publish-stable	-     🔗	N/A	See Details

---

✅  changelog workflow has finished in 1 minute 58 seconds (3 minutes 11 seconds less than main branch avg.) and finished at 6th Dec, 2022.

---

Job	Failed Steps	Tests
changelog	-     🔗	N/A	See Details

---

✅  build-and-test workflow has finished in 43 minutes 49 seconds (20 minutes 25 seconds less than main branch avg.) and finished at 6th Dec, 2022.

---

Job	Failed Steps	Tests
unittest-matrix (1.18, internal)	-     🔗	✅ 592  ❌ 0  ⏭ 0    🔗	See Details
correctness-metrics	-     🔗	✅ 2  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, internal)	-     🔗	✅ 592  ❌ 0  ⏭ 0    🔗	See Details
correctness-traces	-     🔗	✅ 17  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.18, processor)	-     🔗	✅ 1465  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, processor)	-     🔗	✅ 1465  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.18, extension)	-     🔗	✅ 528  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, extension)	-     🔗	✅ 528  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.18, receiver-0)	-     🔗	✅ 2533  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, receiver-0)	-     🔗	✅ 2533  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.18, receiver-1)	-     🔗	✅ 1845  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.18, other)	-     🔗	✅ 4355  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, receiver-1)	-     🔗	✅ 1845  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, exporter)	-     🔗	✅ 2416  ❌ 0  ⏭ 0    🔗	See Details
integration-tests	-     🔗	✅ 59  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.19, other)	-     🔗	✅ 4355  ❌ 0  ⏭ 0    🔗	See Details
unittest-matrix (1.18, exporter)	-     🔗	✅ 2416  ❌ 0  ⏭ 0    🔗	See Details
setup-environment	-     🔗	N/A	See Details
checks	-     🔗	N/A	See Details
check-codeowners	-     🔗	N/A	See Details
check-collector-module-version	-     🔗	N/A	See Details
lint-matrix (receiver-0)	-     🔗	N/A	See Details
lint-matrix (receiver-1)	-     🔗	N/A	See Details
lint-matrix (processor)	-     🔗	N/A	See Details
lint-matrix (exporter)	-     🔗	N/A	See Details
lint-matrix (extension)	-     🔗	N/A	See Details
lint-matrix (internal)	-     🔗	N/A	See Details
lint-matrix (other)	-     🔗	N/A	See Details
build-examples	-     🔗	N/A	See Details
lint	-     🔗	N/A	See Details
unittest (1.19)	-     🔗	N/A	See Details
unittest (1.18)	-     🔗	N/A	See Details
cross-compile (darwin, amd64)	-     🔗	N/A	See Details
cross-compile (darwin, arm64)	-     🔗	N/A	See Details
cross-compile (linux, 386)	-     🔗	N/A	See Details
cross-compile (linux, amd64)	-     🔗	N/A	See Details
cross-compile (linux, arm)	-     🔗	N/A	See Details
cross-compile (linux, arm64)	-     🔗	N/A	See Details
cross-compile (linux, ppc64le)	-     🔗	N/A	See Details
cross-compile (windows, 386)	-     🔗	N/A	See Details
cross-compile (windows, amd64)	-     🔗	N/A	See Details
build-package (deb)	-     🔗	N/A	See Details
windows-msi	-     🔗	N/A	See Details
build-package (rpm)	-     🔗	N/A	See Details
publish-check	-     🔗	N/A	See Details
publish-stable	-     🔗	N/A	See Details
publish-dev	-     🔗	N/A	See Details

---

✅  build-and-test-windows workflow has finished in 32 minutes 49 seconds and finished at 6th Dec, 2022. There are 20 test failures.

---

Job	Failed Steps	Tests
windows-unittest-matrix (internal)	-     🔗	✅ 556  ❌ 0  ⏭ 0    🔗	See Details
windows-unittest-matrix (extension)	-     🔗	✅ 515  ❌ 0  ⏭ 0    🔗	See Details
windows-unittest-matrix (exporter)	-     🔗	✅ 2379  ❌ 0  ⏭ 0    🔗	See Details
windows-unittest-matrix (processor)	-     🔗	✅ 1465  ❌ 0  ⏭ 0    🔗	See Details
windows-unittest-matrix (receiver-0)	-     🔗	✅ 2526  ❌ 0  ⏭ 0    🔗	See Details
windows-unittest-matrix (other)	-     🔗	✅ 4207  ❌ 13  ⏭ 0    🔗	See Details
windows-unittest-matrix (receiver-1)	-     🔗	✅ 1789  ❌ 7  ⏭ 0    🔗	See Details
windows-unittest	-     🔗	N/A	See Details

---

✅  load-tests workflow has finished in 12 minutes (3 minutes 41 seconds less than main branch avg.) and finished at 6th Dec, 2022.

---

Job	Failed Steps	Tests
loadtest (TestIdleMode)	-     🔗	✅ 1  ❌ 0  ⏭ 0    🔗	See Details
loadtest (TestTraceAttributesProcessor)	-     🔗	✅ 3  ❌ 0  ⏭ 0    🔗	See Details
loadtest (TestMetric10kDPS|TestMetricsFromFile)	-     🔗	✅ 6  ❌ 0  ⏭ 0    🔗	See Details
loadtest (TestTraceNoBackend10kSPS|TestTrace1kSPSWithAttrs)	-     🔗	✅ 8  ❌ 0  ⏭ 0    🔗	See Details
loadtest (TestMetricResourceProcessor|TestTrace10kSPS)	-     🔗	✅ 12  ❌ 0  ⏭ 0    🔗	See Details
loadtest (TestTraceBallast1kSPSWithAttrs|TestTraceBallast1kSPSAddAttrs)	-     🔗	✅ 10  ❌ 0  ⏭ 0    🔗	See Details
loadtest (TestBallastMemory|TestLog10kDPS)	-     🔗	✅ 19  ❌ 0  ⏭ 0    🔗	See Details
setup-environment	-     🔗	N/A	See Details

---

✅  prometheus-compliance-tests workflow has finished in 13 minutes 42 seconds (⚠️ 4 minutes 37 seconds more than main branch avg.) and finished at 6th Dec, 2022.

---

Job	Failed Steps	Tests
prometheus-compliance-tests	-     🔗	✅ 21  ❌ 0  ⏭ 0    🔗	See Details

---

🔎 See details on Foresight

^{*You can configure Foresight comments in your organization settings page.}

[dmitryax]

@djaglowski can you please take a look whenever you have a chance?

[djaglowski]

LGTM