[receiver/saphanareceiver] New SAP HANA metrics receiver

.github/CODEOWNERS

@@ -146,6 +146,7 @@ receiver/rabbitmqreceiver/                           @open-telemetry/collector-c
 receiver/receivercreator/                            @open-telemetry/collector-contrib-approvers @jrcamp
 receiver/redisreceiver/                              @open-telemetry/collector-contrib-approvers @pmcollins @dmitryax
 receiver/riakreceiver/                               @open-telemetry/collector-contrib-approvers @djaglowski @armstrmi
+receiver/saphanareceiver/                            @open-telemetry/collector-contrib-approvers @pmm-sumo @dehaansa
 receiver/sapmreceiver/                               @open-telemetry/collector-contrib-approvers @owais
 receiver/signalfxreceiver/                           @open-telemetry/collector-contrib-approvers @pjanotti @dmitryax
 receiver/skywalkingreceiver                          @open-telemetry/collector-contrib-approvers @JaredTan95

CHANGELOG.md

@@ -17,6 +17,7 @@
 
 ### 🚀 New components 🚀
 
+- `saphanareceiver`: Added implementation of SAP HANA Metric Receiver (#8827)
 - `iisreceiver`: Add implementation of IIS Metric Receiver (#8832)
 - `sqlserverreceiver`: Add implementation of SQL Server Metric Receiver (#8398)
 - `activedirectorydsreceiver`: Add implementation of Active Directory Domain Services metric receiver (#9359)

cmd/configschema/go.mod

@@ -47,6 +47,7 @@ require (
 	github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace v1.4.0 // indirect
 	github.com/Microsoft/go-winio v0.5.1 // indirect
 	github.com/ReneKroon/ttlcache/v2 v2.11.0 // indirect
+	github.com/SAP/go-hdb v0.105.5 // indirect
 	github.com/SermoDigital/jose v0.9.2-0.20161205224733-f6df55f235c2 // indirect
 	github.com/Shopify/sarama v1.32.0 // indirect
 	github.com/Showmax/go-fqdn v1.0.0 // indirect
@@ -353,6 +354,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/receivercreator v0.49.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redisreceiver v0.49.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver v0.49.0 // indirect
+	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/saphanareceiver v0.49.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sapmreceiver v0.49.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/signalfxreceiver v0.49.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/simpleprometheusreceiver v0.49.0 // indirect
@@ -442,7 +444,7 @@ require (
 	go.etcd.io/bbolt v1.3.6 // indirect
 	go.mongodb.org/atlas v0.15.0 // indirect
 	go.opencensus.io v0.23.0 // indirect
-	go.opentelemetry.io/collector/model v0.49.0 // indirect
+	go.opentelemetry.io/collector/model v0.49.1-0.20220428142054-b34df3a7e7e9 // indirect
 	go.opentelemetry.io/collector/semconv v0.0.0-20220422001137-87ab5de64ce4 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.31.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.31.0 // indirect
@@ -453,7 +455,7 @@ require (
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/goleak v1.1.12 // indirect
 	go.uber.org/zap v1.21.0 // indirect
-	golang.org/x/crypto v0.0.0-20220214200702-86341886e292 // indirect
+	golang.org/x/crypto v0.0.0-20220307211146-efcb8507fb70 // indirect
 	golang.org/x/net v0.0.0-20220325170049-de3da57026de // indirect
 	golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a // indirect
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
@@ -770,6 +772,8 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redis
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver => ../../receiver/riakreceiver
 
+replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/saphanareceiver => ../../receiver/saphanareceiver
+
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sapmreceiver => ../../receiver/sapmreceiver
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/signalfxreceiver => ../../receiver/signalfxreceiver

go.mod

@@ -112,6 +112,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/receivercreator v0.49.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redisreceiver v0.49.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver v0.49.0
+	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/saphanareceiver v0.49.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sapmreceiver v0.49.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/signalfxreceiver v0.49.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/simpleprometheusreceiver v0.49.0
@@ -165,6 +166,7 @@ require (
 	github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace v1.4.0 // indirect
 	github.com/Microsoft/go-winio v0.5.1 // indirect
 	github.com/ReneKroon/ttlcache/v2 v2.11.0 // indirect
+	github.com/SAP/go-hdb v0.105.5 // indirect
 	github.com/SermoDigital/jose v0.9.2-0.20161205224733-f6df55f235c2 // indirect
 	github.com/Shopify/sarama v1.32.0 // indirect
 	github.com/Showmax/go-fqdn v1.0.0 // indirect
@@ -441,7 +443,7 @@ require (
 	go.etcd.io/bbolt v1.3.6 // indirect
 	go.mongodb.org/atlas v0.15.0 // indirect
 	go.opencensus.io v0.23.0 // indirect
-	go.opentelemetry.io/collector/model v0.49.0 // indirect
+	go.opentelemetry.io/collector/model v0.49.1-0.20220428142054-b34df3a7e7e9 // indirect
 	go.opentelemetry.io/collector/pdata v0.49.1-0.20220428142054-b34df3a7e7e9 // indirect
 	go.opentelemetry.io/collector/semconv v0.0.0-20220422001137-87ab5de64ce4 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.31.0 // indirect
@@ -457,7 +459,7 @@ require (
 	go.uber.org/goleak v1.1.12 // indirect
 	go.uber.org/multierr v1.8.0 // indirect
 	go.uber.org/zap v1.21.0 // indirect
-	golang.org/x/crypto v0.0.0-20220214200702-86341886e292 // indirect
+	golang.org/x/crypto v0.0.0-20220307211146-efcb8507fb70 // indirect
 	golang.org/x/mod v0.5.1 // indirect
 	golang.org/x/net v0.0.0-20220325170049-de3da57026de // indirect
 	golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a // indirect
@@ -774,6 +776,8 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redis
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver => ./receiver/riakreceiver
 
+replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/saphanareceiver => ./receiver/saphanareceiver
+
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sapmreceiver => ./receiver/sapmreceiver
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/signalfxreceiver => ./receiver/signalfxreceiver

internal/components/components.go

@@ -132,6 +132,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/receivercreator"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redisreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/saphanareceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/sapmreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/signalfxreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/simpleprometheusreceiver"
@@ -213,6 +214,7 @@ func Components() (component.Factories, error) {
 		receivercreator.NewFactory(),
 		redisreceiver.NewFactory(),
 		riakreceiver.NewFactory(),
+		saphanareceiver.NewFactory(),
 		sapmreceiver.NewFactory(),
 		signalfxreceiver.NewFactory(),
 		simpleprometheusreceiver.NewFactory(),

internal/components/receivers_test.go

@@ -204,6 +204,9 @@ func TestDefaultReceivers(t *testing.T) {
 		{
 			receiver: "sapm",
 		},
+		{
+			receiver: "saphana",
+		},
 		{
 			receiver: "signalfx",
 		},

receiver/saphanareceiver/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

receiver/saphanareceiver/README.md

@@ -0,0 +1,95 @@
+# SAP HANA Receiver
+
+This receiver can fetch stats from a SAP HANA instance. It leverages the [driver](https://github.com/SAP/go-hdb) written by SAP for connecting to SAP HANA with the golang sql module to execute several monitoring queries.
+
+Supported pipeline types: `metrics`
+
+> :construction: This receiver is currently in **BETA**.
+
+### Prerequisites
+
+> The receiver is intended to support SAP HANA version 2, older versions have not been tested.
+
+A monitoring user requires `SELECT` access to the relevant monitoring views. The following sql script should create a monitoring role and apply it to a monitoring user if executed by a user with sufficient permissions connected to the SAP HANA instance.
+
+```sql
+--Create the user
+CREATE RESTRICTED USER otel_monitoring_user PASSWORD <password>;
+
+--Enable user login
+ALTER USER otel_monitoring_user ENABLE CLIENT CONNECT;
+
+--Create the monitoring role
+CREATE ROLE OTEL_MONITORING;
+
+--Grant permissions to the relevant views
+GRANT CATALOG READ TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_BACKUP_CATALOG TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_BLOCKED_TRANSACTIONS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_CONNECTIONS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_CS_ALL_COLUMNS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_CS_TABLES TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_DATABASE TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_DISKS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_HOST_RESOURCE_UTILIZATION TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_LICENSES TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_RS_TABLES TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_SERVICE_COMPONENT_MEMORY TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_SERVICE_MEMORY TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_SERVICE_REPLICATION TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_SERVICE_STATISTICS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_SERVICE_THREADS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_SERVICES TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_VOLUME_IO_TOTAL_STATISTICS TO OTEL_MONITORING;
+GRANT SELECT ON SYS.M_WORKLOAD TO OTEL_MONITORING;
+GRANT SELECT ON _SYS_STATISTICS.STATISTICS_CURRENT_ALERTS TO OTEL_MONITORING;
+
+--Add the OTEL_MONITOR role to the monitoring user
+GRANT OTEL_MONITORING TO otel_monitoring_user;
+```
+
+## Configuration
+
+> :information_source: This receiver is in beta and configuration fields are subject to change.
+
+The following settings are required:
+
+- `endpoint` (default: `localhost:33015`): The hostname/IP address and port of the SAP HANA instance
+- `username`
+- `password`
+
+The following settings are optional:
+
+- `collection_interval` (default = `60s`): This receiver runs on an interval.
+Each time it runs, it queries memcached, creates metrics, and sends them to the
+next consumer. The `collection_interval` configuration option tells this
+receiver the duration between runs. This value must be a string readable by
+Golang's `ParseDuration` function (example: `1h30m`). Valid time units are
+`ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
+- `tls`:
+  - `insecure` (default = true): whether to disable client transport security for the exporter's connection.
+  - `ca_file`: path to the CA cert. For a client this verifies the server certificate. Should only be used if `insecure` is set to false.
+  - `cert_file`: path to the TLS cert to use for TLS required connections. Should only be used if `insecure` is set to false.
+  - `key_file`: path to the TLS key to use for TLS required connections. Should only be used if `insecure` is set to false.
+
+Example:
+
+```yaml
+receivers:
+  saphana:
+    endpoint: "localhost:33015"
+    collection_interval: 60s
+    metrics:
+      saphana.cpu.used:
+        enabled: false
+```
+
+The full list of settings exposed for this receiver are documented [here](./config.go)
+with detailed sample configurations [here](./testdata/config.yaml).
+
+## Metrics
+
+Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml). Further details of the monitoring queries used to collect them may be found in [queries.go](./queries.go).
+
+> If all of the metrics collected by a given monitoring query are marked as `enabled: false` in the receiver configration, the monitoring query will not be executed.
+