Command to validate metadata (DataDog#2269)

* added metadata validation command

* changed command from validate to metadata, more validations

* added metadata verify to travis

* refactor, fix unicode handling

* refactor, reflect errors in exit code

* add validation for unit names too

* address metric_prefix comments

* short_name is optional

* fixed metadata validations

* changed description field to recommended optional field

* fixed new lines at end of file

Author: taylor-chen

.travis.yml

@@ -45,13 +45,15 @@ jobs:
       script:
         - ddev dep verify
         - ddev manifest verify --include-extras
+        - ddev metadata verify
         - ddev test --cov
         - ddev test --bench || true
     - stage: test
       env: CHECK=datadog_checks_base PYTHON3=true
       script:
         - ddev dep verify
         - ddev manifest verify --include-extras
+        - ddev metadata verify
         - travis_retry ddev test --cov ${CHECK}
         - ddev test ${CHECK} --bench || true
     - stage: test

consul/metadata.csv

@@ -23,7 +23,6 @@ consul.runtime.heap_objects,gauge,10,object,,Number of objects allocated on the
 consul.runtime.sys_bytes,gauge,10,byte,,Total size of the virtual address space reserved by the Go runtime,0,consul,
 consul.runtime.malloc_count,gauge,10,object,,Cumulative count of heap objects allocated,0,consul,
 consul.runtime.free_count,gauge,10,object,,Cumulative count of heap objects freed,0,consul,
-consul.runtime.heap_objects,gauge,10,byte,,Bytes of allocated heap objects,0,consul,heap alloc
 consul.runtime.total_gc_pause_ns,gauge,10,nanosecond,,Cumulative nanoseconds in GC stop-the-world pauses since Consul started,0,consul,
 consul.runtime.total_gc_runs,gauge,10,,,Number of completed GC cycles,0,consul,
 consul.raft.state.leader,rate,10,event,,Number of completed leader elections,-1,consul,leader elecs

coredns/manifest.json

@@ -2,6 +2,7 @@
   "maintainer": "[email protected]",
   "manifest_version": "1.0.0",
   "name": "coredns",
+  "metric_prefix": "coredns.",
   "display_name": "CoreDNS",
   "short_description": "CoreDNS collects DNS metrics in Kubernetes.",
   "support": "core",

couch/metadata.csv

@@ -162,7 +162,7 @@ couchdb.couchdb.query_server.vdu_process_time.geometric_mean,gauge,,millisecond,
 couchdb.couchdb.query_server.vdu_process_time.harmonic_mean,gauge,,millisecond,,Harmonic_mean of the duration of validate_doc_update function calls,-1,couchdb2,
 couchdb.couchdb.query_server.vdu_process_time.median,gauge,,millisecond,,Median of the duration of validate_doc_update function calls,-1,couchdb2,
 couchdb.couchdb.query_server.vdu_process_time.variance,gauge,,millisecond,,Variance of the duration of validate_doc_update function calls,-1,couchdb2,
-couchdb.couchdb.query_server.vdu_process_time.standard_deviation,gaugemillisecond,,,,Standard_deviation of the duration of validate_doc_update function calls,-1,couchdb2,
+couchdb.couchdb.query_server.vdu_process_time.standard_deviation,gauge,,millisecond,,Standard_deviation of the duration of validate_doc_update function calls,-1,couchdb2,
 couchdb.couchdb.query_server.vdu_process_time.skewness,gauge,,millisecond,,Skewness of the duration of validate_doc_update function calls,-1,couchdb2,
 couchdb.couchdb.query_server.vdu_process_time.kurtosis,gauge,,millisecond,,Kurtosis of the duration of validate_doc_update function calls,-1,couchdb2,
 couchdb.couchdb.query_server.vdu_process_time.percentile.50,gauge,,millisecond,,Percentile 50 of the duration of validate_doc_update function calls,-1,couchdb2,

datadog_checks_dev/README.md

@@ -94,6 +94,7 @@ Commands:
   create    Create scaffolding for a new integration
   dep       Manage dependencies
   manifest  Manage manifest files
+  metadata  Manage metadata files
   release   Manage the release of checks
   test      Run tests
 ```
@@ -354,6 +355,34 @@ Options:
   -h, --help            Show this message and exit.
 ```
 
+#### Metadata
+
+```console
+$ ddev metadata -h
+Usage: ddev metadata [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  -h, --help  Show this message and exit.
+
+Commands:
+  verify  Validate `metadata.csv` files, takes optional `check` argument
+```
+
+##### Verify
+
+```console
+$ ddev metadata verify -h
+Usage: ddev metadata verify [OPTIONS] [CHECK]
+
+  Validates metadata.csv files
+
+  If `check` is specified, only the check will be validated, otherwise all
+  matching files in directory.
+
+Options:
+  -h, --help  Show this message and exit.
+```
+
 #### Release
 
 ```console

datadog_checks_dev/datadog_checks/dev/tooling/commands/__init__.py

@@ -9,6 +9,7 @@
 from .meta import meta
 from .release import release
 from .test import test
+from .metadata import metadata
 
 ALL_COMMANDS = (
     clean,
@@ -17,6 +18,7 @@
     dep,
     manifest,
     meta,
+    metadata,
     release,
     test,
 )