Fix unifi_console metadata.csv and validate metadata.csv tests (DataDog#2704)

* Fix unifi_console metadata and tests

* Lint

* Fix config and models

* Fix manifest

* Update unifi_console/metadata.csv

Co-authored-by: Ursula Chen <[email protected]>

---------

Co-authored-by: Ursula Chen <[email protected]>

Author: Kyle-Neale

unifi_console/datadog_checks/unifi_console/config_models/instance.py

@@ -85,6 +85,7 @@ class InstanceConfig(BaseModel):
     timeout: Optional[float] = None
     tls_ca_cert: Optional[str] = None
     tls_cert: Optional[str] = None
+    tls_ciphers: Optional[tuple[str, ...]] = None
     tls_ignore_warning: Optional[bool] = None
     tls_private_key: Optional[str] = None
     tls_protocols_allowed: Optional[tuple[str, ...]] = None

unifi_console/datadog_checks/unifi_console/data/conf.yaml.example

@@ -326,6 +326,16 @@ instances:
     #   - TLSv1.2
     #   - TLSv1.3
 
+    ## @param tls_ciphers - list of strings - optional
+    ## The list of ciphers suites to use when connecting to an endpoint. If not specified, 
+    ## `ALL` ciphers are used. For list of ciphers see: 
+    ## https://www.openssl.org/docs/man1.0.2/man1/ciphers.html
+    #
+    # tls_ciphers:
+    #   - TLS_AES_256_GCM_SHA384
+    #   - TLS_CHACHA20_POLY1305_SHA256
+    #   - TLS_AES_128_GCM_SHA256
+
     ## @param headers - mapping - optional
     ## The headers parameter allows you to send specific headers with every request.
     ## You can use it for explicitly specifying the host header or adding headers for

unifi_console/manifest.json

@@ -34,8 +34,8 @@
         "creates_events": false
       },
       "metrics": {
-        "prefix": "unifi.",
-        "check": "unifi.device.status",
+        "prefix": "unifi_console.",
+        "check": "unifi_console.device.status",
         "metadata_path": "metadata.csv"
       },
       "service_checks": {

unifi_console/metadata.csv

@@ -1,41 +1,42 @@
 metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric
-unifi.device.status,gauge,,,,Device status,0,unifi_console,status,
-unifi.device.uptime,gauge,,second,,Device uptime,1,unifi_console,uptime,
-unifi.device.clients,gauge,,,,Clients number,0,unifi_console,clients nb,
-unifi.device.satisfaction,gauge,,percent,,Device Satisfaction,1,unifi_console,satisfaction,
-unifi.device.system.cpu.pct,gauge,,percent,,% of CPU used,0,unifi_console,cpu pct,
-unifi.device.system.mem.used,gauge,,byte,,Memory used,0,unifi_console,mem used,
-unifi.device.system.mem.total,gauge,,byte,,Total Memory,0,unifi_console,total mem,
-unifi.device.system.mem.buffer,gauge,,byte,,Memory buffer,0,unifi_console,mem buffer,
-unifi.device.system.mem.pct,gauge,,percent,,% of memory used,0,unifi_console,mem pct,
-unifi.device.tx_packets,gauge,,packet,,Number of transmitted packets,1,unifi_console,tx packets,
-unifi.device.tx_bytes,gauge,,byte,,Number of transmitted Bytes,1,unifi_console,tx bytes,
-unifi.device.tx_errors,gauge,,,,Number of transmitted errors,1,unifi_console,tx errors,
-unifi.device.tx_dropped,gauge,,,,Number of transmitted dropped,1,unifi_console,tx dropped,
-unifi.device.tx_retries,gauge,,,,Number of transmitted retries,1,unifi_console,tx retries,
-unifi.device.rx_packets,gauge,,packet,,Number of received packets,1,unifi_console,rx packets,
-unifi.device.rx_bytes,gauge,,byte,,Number of received Bytes,1,unifi_console,rx bytes,
-unifi.device.rx_errors,gauge,,,,Number of received errors,1,unifi_console,rx errors,
-unifi.device.rx_dropped,gauge,,,,Number of received dropped,1,unifi_console,rx dropped,
-unifi.device.guests,gauge,,,,Number of guests,0,unifi_console,guests,
-unifi.device.uplink.rx_bytes,gauge,,byte,,Uplink received bytes,1,unifi_console,uplink rx bytes,
-unifi.device.uplink.rx_dropped,gauge,,,,Uplink number of received dropped,1,unifi_console,uplink rx dropped,
-unifi.device.uplink.rx_errors,gauge,,,,uplink number of received errors,1,unifi_console,uplink rx errors,
-unifi.device.uplink.rx_packets,gauge,,packet,,Uplink received packets,1,unifi_console,uplink rx packets,
-unifi.device.uplink.tx_bytes,gauge,,byte,,Uplink transmitted bytes,1,unifi_console,uplink tx bytes,
-unifi.device.uplink.tx_dropped,gauge,,,,Uplink number of transmitted dropped,1,unifi_console,uplink tx dropped,
-unifi.device.uplink.tx_errors,gauge,,,,Uplink number of transmitted errors,1,unifi_console,uplink tx errors,
-unifi.device.uplink.tx_packets,gauge,,packet,,Uplink transmitted packets,1,unifi_console,uplink tx packets,
-unifi.device.uplink.up,gauge,,,,Uplink status,0,unifi_console,status,
-unifi.client.noise,gauge,,,,Client noise in dBm,0,unifi_console,noise,
-unifi.client.rx_bytes,gauge,,byte,,Client received bytes,1,unifi_console,client rx bytes,
-unifi.client.rx_packets,gauge,,packet,,Client received packets,1,unifi_console,client rx packets,
-unifi.client.rx_rate,gauge,,byte,second,Client received rate,1,unifi_console,client rx rate,
-unifi.client.satisfaction,gauge,,percent,,Client satisfaction,1,unifi_console,client satisfaction,
-unifi.client.signal,gauge,,,,Client signal in dBm,1,unifi_console,client signal,
-unifi.client.tx_bytes,gauge,,byte,,Client transmitted bytes,1,unifi_console,client tx bytes,
-unifi.client.tx_packets,gauge,,packet,,Client transmitted packets,1,unifi_console,client tx packets,
-unifi.client.tx_rate,gauge,,byte,second,Client transmitted rate,1,unifi_console,client tx rate,
-unifi.client.tx_retries,gauge,,,,Client transmitted retry,1,unifi_console,client transmitted retry,
-unifi.client.uptime,gauge,,second,,Client uptime,1,unifi_console,client uptime,
-unifi.client.up,gauge,,,,Client up,0,unifi_console,client up,
+unifi_console.device.status,gauge,,,,Device status,0,unifi_console,status,
+unifi_console.device.uptime,gauge,,second,,Device uptime,1,unifi_console,uptime,
+unifi_console.device.clients,gauge,,,,Clients number,0,unifi_console,clients nb,
+unifi_console.device.satisfaction,gauge,,percent,,Device Satisfaction,1,unifi_console,satisfaction,
+unifi_console.device.system.cpu.pct,gauge,,percent,,% of CPU used,0,unifi_console,cpu pct,
+unifi_console.device.system.mem.used,gauge,,byte,,Memory used,0,unifi_console,mem used,
+unifi_console.device.system.mem.total,gauge,,byte,,Total Memory,0,unifi_console,total mem,
+unifi_console.device.system.mem.buffer,gauge,,byte,,Memory buffer,0,unifi_console,mem buffer,
+unifi_console.device.system.mem.pct,gauge,,percent,,% of memory used,0,unifi_console,mem pct,
+unifi_console.device.tx_packets,gauge,,packet,,Number of transmitted packets,1,unifi_console,tx packets,
+unifi_console.device.tx_bytes,gauge,,byte,,Number of transmitted Bytes,1,unifi_console,tx bytes,
+unifi_console.device.tx_errors,gauge,,,,Number of transmitted errors,1,unifi_console,tx errors,
+unifi_console.device.tx_dropped,gauge,,,,Number of transmitted dropped,1,unifi_console,tx dropped,
+unifi_console.device.tx_retries,gauge,,,,Number of transmitted retries,1,unifi_console,tx retries,
+unifi_console.device.rx_packets,gauge,,packet,,Number of received packets,1,unifi_console,rx packets,
+unifi_console.device.rx_bytes,gauge,,byte,,Number of received bytes,1,unifi_console,rx bytes,
+unifi_console.device.rx_errors,gauge,,,,Number of received errors,1,unifi_console,rx errors,
+unifi_console.device.rx_dropped,gauge,,,,Number of received dropped,1,unifi_console,rx dropped,
+unifi_console.device.guests,gauge,,,,Number of guests,0,unifi_console,guests,
+unifi_console.device.uplink.rx_bytes,gauge,,byte,,Uplink received bytes,1,unifi_console,uplink rx bytes,
+unifi_console.device.uplink.rx_dropped,gauge,,,,Uplink number of received dropped,1,unifi_console,uplink rx dropped,
+unifi_console.device.uplink.rx_errors,gauge,,,,uplink number of received errors,1,unifi_console,uplink rx errors,
+unifi_console.device.uplink.rx_packets,gauge,,packet,,Uplink received packets,1,unifi_console,uplink rx packets,
+unifi_console.device.uplink.tx_bytes,gauge,,byte,,Uplink transmitted bytes,1,unifi_console,uplink tx bytes,
+unifi_console.device.uplink.tx_dropped,gauge,,,,Uplink number of transmitted dropped,1,unifi_console,uplink tx dropped,
+unifi_console.device.uplink.tx_errors,gauge,,,,Uplink number of transmitted errors,1,unifi_console,uplink tx errors,
+unifi_console.device.uplink.tx_packets,gauge,,packet,,Uplink transmitted packets,1,unifi_console,uplink tx packets,
+unifi_console.device.uplink.up,gauge,,,,Uplink status,0,unifi_console,status,
+unifi_console.client.noise,gauge,,,,Client noise in dBm,0,unifi_console,noise,
+unifi_console.client.rx_bytes,gauge,,byte,,Client received bytes,1,unifi_console,client rx bytes,
+unifi_console.client.rx_packets,gauge,,packet,,Client received packets,1,unifi_console,client rx packets,
+unifi_console.client.rx_rate,gauge,,byte,second,Client received rate,1,unifi_console,client rx rate,
+unifi_console.client.satisfaction,gauge,,percent,,Client satisfaction,1,unifi_console,client satisfaction,
+unifi_console.client.signal,gauge,,,,Client signal in dBm,1,unifi_console,client signal,
+unifi_console.client.tx_bytes,gauge,,byte,,Client transmitted bytes,1,unifi_console,client tx bytes,
+unifi_console.client.tx_packets,gauge,,packet,,Client transmitted packets,1,unifi_console,client tx packets,
+unifi_console.client.tx_rate,gauge,,byte,second,Client transmitted rate,1,unifi_console,client tx rate,
+unifi_console.client.tx_retries,gauge,,,,Client transmitted retry,1,unifi_console,client transmitted retry,
+unifi_console.client.uptime,gauge,,second,,Client uptime,1,unifi_console,client uptime,
+unifi_console.client.up,gauge,,,,Client up,0,unifi_console,client up,
+unifi_console.healthy,gauge,,,,Health status,0,unifi_console,healthy,

unifi_console/tests/test_check.py

@@ -5,6 +5,7 @@
 from mock import patch
 
 from datadog_checks.base import AgentCheck
+from datadog_checks.dev.utils import get_metadata_metrics
 from datadog_checks.unifi_console.check import UnifiConsoleCheck
 from datadog_checks.unifi_console.errors import APIConnectionError
 from datadog_checks.unifi_console.types import ControllerInfo, Count, Gauge, Rate
@@ -32,6 +33,7 @@ def test_metrics_submission(aggregator, dd_run_check, instance):
                 )
     aggregator.assert_metric('unifi_console.healthy', metric_type=aggregator.GAUGE)
     aggregator.assert_all_metrics_covered()
+    aggregator.assert_metrics_using_metadata(get_metadata_metrics())
 
 
 @pytest.mark.usefixtures("mock_api")