Added metrics support to examples and observability stack

Author: xBlaz3kx

example/1.6/cp/charge_point_sim.go

@@ -8,15 +8,14 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/lorenzodonini/ocpp-go/ocpp1.6/logging"
-	"github.com/sirupsen/logrus"
-
 	ocpp16 "github.com/lorenzodonini/ocpp-go/ocpp1.6"
 	"github.com/lorenzodonini/ocpp-go/ocpp1.6/core"
 	"github.com/lorenzodonini/ocpp-go/ocpp1.6/localauth"
+	"github.com/lorenzodonini/ocpp-go/ocpp1.6/logging"
 	"github.com/lorenzodonini/ocpp-go/ocpp1.6/types"
 	"github.com/lorenzodonini/ocpp-go/ocppj"
 	"github.com/lorenzodonini/ocpp-go/ws"
+	"github.com/sirupsen/logrus"
 )
 
 const (

example/1.6/cs/central_system_sim.go

@@ -1,13 +1,22 @@
 package main
 
 import (
+	"context"
 	"crypto/tls"
 	"crypto/x509"
 	"os"
 	"strconv"
 	"time"
 
+	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
+	metricsdk "go.opentelemetry.io/otel/sdk/metric"
+	"go.opentelemetry.io/otel/sdk/resource"
+	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
 
 	ocpp16 "github.com/lorenzodonini/ocpp-go/ocpp1.6"
 	"github.com/lorenzodonini/ocpp-go/ocpp1.6/core"
@@ -28,6 +37,8 @@ const (
 	envVarCaCertificate        = "CA_CERTIFICATE_PATH"
 	envVarServerCertificate    = "SERVER_CERTIFICATE_PATH"
 	envVarServerCertificateKey = "SERVER_CERTIFICATE_KEY_PATH"
+	envVarMetricsEnabled       = "METRICS_ENABLED"
+	envVarMetricsAddress       = "METRICS_ADDRESS"
 )
 
 var log *logrus.Logger
@@ -188,6 +199,54 @@ func exampleRoutine(chargePointID string, handler *CentralSystemHandler) {
 	}
 }
 
+// sets up OTLP metrics exporter
+func setupMetrics(address string) error {
+	grpcOpts := []grpc.DialOption{
+		grpc.WithTransportCredentials(insecure.NewCredentials()),
+	}
+
+	client, err := grpc.NewClient(address, grpcOpts...)
+
+	if err != nil {
+		return errors.Wrap(err, "failed to create gRPC connection to collector")
+	}
+
+	ctx := context.Background()
+
+	exporter, err := otlpmetricgrpc.New(ctx, otlpmetricgrpc.WithGRPCConn(client))
+	if err != nil {
+		return errors.Wrap(err, "failed to create otlp metric exporter")
+	}
+
+	resource, err := resource.New(ctx,
+		resource.WithAttributes(
+			semconv.ServiceNameKey.String("centralSystem-demo"),
+			semconv.ServiceVersionKey.String("example"),
+		),
+		resource.WithFromEnv(),
+		resource.WithContainer(),
+		resource.WithOS(),
+		resource.WithOSType(),
+		resource.WithHost(),
+	)
+	if err != nil {
+		return errors.Wrap(err, "failed to create resource")
+	}
+
+	meterProvider := metricsdk.NewMeterProvider(
+		metricsdk.WithReader(
+			metricsdk.NewPeriodicReader(
+				exporter,
+				metricsdk.WithInterval(10*time.Second),
+			),
+		),
+		metricsdk.WithResource(resource),
+	)
+
+	otel.SetMeterProvider(meterProvider)
+	return nil
+}
+
 // Start function
 func main() {
 	// Load config from ENV
@@ -198,6 +257,16 @@ func main() {
 	} else {
 		log.Printf("no valid %v environment variable found, using default port", envVarServerPort)
 	}
+
+	// Setup metrics if enabled
+	if t, _ := os.LookupEnv(envVarMetricsEnabled); t == "true" {
+		address, _ := os.LookupEnv(envVarMetricsAddress)
+		if err := setupMetrics(address); err != nil {
+			log.Error(err)
+			return
+		}
+	}
+
 	// Check if TLS enabled
 	t, _ := os.LookupEnv(envVarTls)
 	tlsEnabled, _ := strconv.ParseBool(t)
@@ -207,6 +276,7 @@ func main() {
 	} else {
 		centralSystem = setupCentralSystem()
 	}
+
 	// Support callbacks for all OCPP 1.6 profiles
 	handler := &CentralSystemHandler{chargePoints: map[string]*ChargePointState{}}
 	centralSystem.SetCoreHandler(handler)

example/1.6/docker-compose.tls.yml

@@ -1,4 +1,4 @@
-version: '3'
+version: '3.9'
 services:
   central-system:
     build:
@@ -15,6 +15,8 @@ services:
       - CA_CERTIFICATE_PATH=/usr/local/share/certs/ca.crt
       - SERVER_CERTIFICATE_PATH=/usr/local/share/certs/central-system.crt
       - SERVER_CERTIFICATE_KEY_PATH=/usr/local/share/certs/central-system.key
+      - METRICS_ENABLED=${METRICS_ENABLED:-false}
+      - METRICS_ADDRESS=${METRICS_ADDRESS:-lgtm-stack:4317}
     ports:
       - "443:443"
     networks:

example/1.6/docker-compose.yml

@@ -1,12 +1,14 @@
-version: '3'
+version: '3.9'
 services:
   central-system:
     build:
       context: ../..
-      dockerfile: cs/Dockerfile
+      dockerfile: example/1.6/cs/Dockerfile
     image: ldonini/ocpp1.6-central-system:latest
     container_name: central-system
     environment:
+      - METRICS_ENABLED=${METRICS_ENABLED:-false}
+      - METRICS_ADDRESS=${METRICS_ADDRESS:-lgtm-stack:4317}
       - SERVER_LISTEN_PORT=8887
     ports:
       - "8887:8887"
@@ -19,7 +21,7 @@ services:
         condition: service_started
     build:
       context: ../..
-      dockerfile: cp/Dockerfile
+      dockerfile: example/1.6/cp/Dockerfile
     image: ldonini/ocpp1.6-charge-point:latest
     container_name: charge-point
     environment:

example/2.0.1/csms/csms_sim.go

@@ -1,14 +1,23 @@
 package main
 
 import (
+	"context"
 	"crypto/tls"
 	"crypto/x509"
 	"fmt"
 	"os"
 	"strconv"
 	"time"
 
+	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
+	metricsdk "go.opentelemetry.io/otel/sdk/metric"
+	"go.opentelemetry.io/otel/sdk/resource"
+	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
 
 	"github.com/lorenzodonini/ocpp-go/ocpp2.0.1"
 	"github.com/lorenzodonini/ocpp-go/ocpp2.0.1/availability"
@@ -31,6 +40,8 @@ const (
 	envVarCaCertificate        = "CA_CERTIFICATE_PATH"
 	envVarServerCertificate    = "SERVER_CERTIFICATE_PATH"
 	envVarServerCertificateKey = "SERVER_CERTIFICATE_KEY_PATH"
+	envVarMetricsEnabled       = "METRICS_ENABLED"
+	envVarMetricsAddress       = "METRICS_ADDRESS"
 )
 
 var log *logrus.Logger
@@ -246,6 +257,54 @@ func exampleRoutine(chargingStationID string, handler *CSMSHandler) {
 	// Finish simulation
 }
 
+// sets up OTLP metrics exporter
+func setupMetrics(address string) error {
+	grpcOpts := []grpc.DialOption{
+		grpc.WithTransportCredentials(insecure.NewCredentials()),
+	}
+
+	client, err := grpc.NewClient(address, grpcOpts...)
+
+	if err != nil {
+		return errors.Wrap(err, "failed to create gRPC connection to collector")
+	}
+
+	ctx := context.Background()
+
+	exporter, err := otlpmetricgrpc.New(ctx, otlpmetricgrpc.WithGRPCConn(client))
+	if err != nil {
+		return errors.Wrap(err, "failed to create otlp metric exporter")
+	}
+
+	resource, err := resource.New(ctx,
+		resource.WithAttributes(
+			semconv.ServiceNameKey.String("csms-demo"),
+			semconv.ServiceVersionKey.String("example"),
+		),
+		resource.WithFromEnv(),
+		resource.WithContainer(),
+		resource.WithOS(),
+		resource.WithOSType(),
+		resource.WithHost(),
+	)
+	if err != nil {
+		return errors.Wrap(err, "failed to create resource")
+	}
+
+	meterProvider := metricsdk.NewMeterProvider(
+		metricsdk.WithReader(
+			metricsdk.NewPeriodicReader(
+				exporter,
+				metricsdk.WithInterval(10*time.Second),
+			),
+		),
+		metricsdk.WithResource(resource),
+	)
+
+	otel.SetMeterProvider(meterProvider)
+	return nil
+}
+
 // Start function
 func main() {
 	// Load config from ENV
@@ -256,6 +315,16 @@ func main() {
 	} else {
 		log.Printf("no valid %v environment variable found, using default port", envVarServerPort)
 	}
+
+	// Setup metrics if enabled
+	if t, _ := os.LookupEnv(envVarMetricsEnabled); t == "true" {
+		address, _ := os.LookupEnv(envVarMetricsAddress)
+		if err := setupMetrics(address); err != nil {
+			log.Error(err)
+			return
+		}
+	}
+
 	// Check if TLS enabled
 	t, _ := os.LookupEnv(envVarTls)
 	tlsEnabled, _ := strconv.ParseBool(t)
@@ -265,6 +334,7 @@ func main() {
 	} else {
 		csms = setupCentralSystem()
 	}
+
 	// Support callbacks for all OCPP 2.0.1 profiles
 	handler := &CSMSHandler{chargingStations: map[string]*ChargingStationState{}}
 	csms.SetAuthorizationHandler(handler)

example/2.0.1/docker-compose.tls.yml

@@ -15,6 +15,8 @@ services:
       - CA_CERTIFICATE_PATH=/usr/local/share/certs/ca.crt
       - SERVER_CERTIFICATE_PATH=/usr/local/share/certs/csms.crt
       - SERVER_CERTIFICATE_KEY_PATH=/usr/local/share/certs/csms.key
+      - METRICS_ENABLED=${METRICS_ENABLED:-false}
+      - METRICS_ADDRESS=${METRICS_ADDRESS:-lgtm-stack:4317}
     ports:
       - "443:443"
     networks:

example/2.0.1/docker-compose.yml

@@ -3,11 +3,13 @@ services:
   csms:
     build:
       context: ../..
-      dockerfile: csms/Dockerfile
+      dockerfile: example/2.0.1/csms/Dockerfile
     image: ldonini/ocpp2.0.1-csms:latest
     container_name: csms
     environment:
       - SERVER_LISTEN_PORT=8887
+      - METRICS_ENABLED=${METRICS_ENABLED:-false}
+      - METRICS_ADDRESS=${METRICS_ADDRESS:-lgtm-stack:4317}
     ports:
       - "8887:8887"
     networks:
@@ -16,7 +18,7 @@ services:
   charging-station:
     build:
       context: ../..
-      dockerfile: chargingstation/Dockerfile
+      dockerfile: example/2.0.1/chargingstation/Dockerfile
     image: ldonini/ocpp2.0.1-chargingstation:latest
     container_name: charging-station
     environment:

example/docker-compose.observability.yaml

@@ -0,0 +1,33 @@
+services:
+  # Grafana stack is used for CPMS observability purposes.
+  # For capturing metrics, you can configure the exporters via environment variables
+  # to either Prometheus or OTel Collector (default).
+  # Prometheus needs to be configured so it can scrape your application instance(s).
+  # To simplify testing and development, we will use the Otel collector as the default.
+  # Your CPMS backend will push the metrics in OTLP format to the Otel collector.
+  # The collector comes as a part of the LGTM stack.
+  grafana-lgtm-stack:
+    image: grafana/otel-lgtm
+    container_name: lgtm-stack
+    hostname: lgtm-stack
+    #environment:
+    #  - GF_SECURITY_ADMIN_USER="admin"
+    #  - GF_SECURITY_ADMIN_PASSWORD="admin"
+    volumes:
+      - prometheus:/prometheus
+      - loki:/data/loki
+      - grafana:/var/lib/grafana
+    networks:
+      - sim
+    ports:
+      - "3000:3000"
+      - "4317:4317"
+
+networks:
+  sim:
+    driver: bridge
+
+volumes:
+  prometheus:
+  loki:
+  grafana: