observability.go

// Copyright © 2021 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package io

import (
	"context"

	"github.com/prometheus/client_golang/prometheus"
	"go.thethings.network/lorawan-stack/v3/pkg/errors"
	"go.thethings.network/lorawan-stack/v3/pkg/events"
	"go.thethings.network/lorawan-stack/v3/pkg/metrics"
	"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
)

const subsystem = "gs_io"

type messageMetrics struct {
	repeatedUplinks *metrics.ContextualCounterVec
	droppedMessages *metrics.ContextualCounterVec
}

// Describe implements prometheus.Collector.
func (m *messageMetrics) Describe(ch chan<- *prometheus.Desc) {
	m.repeatedUplinks.Describe(ch)
	m.droppedMessages.Describe(ch)
}

// Collect implements prometheus.Collector.
func (m *messageMetrics) Collect(ch chan<- prometheus.Metric) {
	m.repeatedUplinks.Collect(ch)
	m.droppedMessages.Collect(ch)
}

var ioMetrics = &messageMetrics{
	repeatedUplinks: metrics.NewContextualCounterVec(
		prometheus.CounterOpts{
			Subsystem: subsystem,
			Name:      "uplink_repeated_total",
			Help:      "Total number of repeated gateway uplinks",
		},
		[]string{"protocol"},
	),
	droppedMessages: metrics.NewContextualCounterVec(
		prometheus.CounterOpts{
			Subsystem: subsystem,
			Name:      "message_dropped_total",
			Help:      "Total number of messages dropped",
		},
		[]string{"type", "error"},
	),
}

var (
	evtRepeatUp = events.Define(
		"gs.io.up.repeat", "received repeated uplink message from gateway",
		events.WithVisibility(ttnpb.Right_RIGHT_GATEWAY_TRAFFIC_READ),
		events.WithDataType(&ttnpb.GatewayIdentifiers{}),
	)
	evtDropUplink = events.Define(
		"gs.io.up.drop", "drop uplink message",
		events.WithVisibility(ttnpb.Right_RIGHT_GATEWAY_TRAFFIC_READ),
		events.WithErrorDataType(),
	)
	evtDropStatus = events.Define(
		"gs.io.status.drop", "drop gateway status",
		events.WithVisibility(ttnpb.Right_RIGHT_GATEWAY_STATUS_READ),
		events.WithErrorDataType(),
	)
	evtDropTxAck = events.Define(
		"gs.io.tx.ack.drop", "drop tx ack message",
		events.WithVisibility(ttnpb.Right_RIGHT_GATEWAY_TRAFFIC_READ),
		events.WithErrorDataType(),
	)
)

func registerRepeatUp(ctx context.Context, emitEvent bool, gtw *ttnpb.Gateway, protocol string) {
	ioMetrics.repeatedUplinks.WithLabelValues(ctx, protocol).Inc()
	if emitEvent {
		events.Publish(evtRepeatUp.NewWithIdentifiersAndData(ctx, gtw, nil))
	}
}

func registerDropMessage(ctx context.Context, gtw *ttnpb.Gateway, typ string, err error) {
	switch typ {
	case "uplink":
		events.Publish(evtDropUplink.NewWithIdentifiersAndData(ctx, gtw, err))
	case "status":
		events.Publish(evtDropStatus.NewWithIdentifiersAndData(ctx, gtw, err))
	case "txack":
		events.Publish(evtDropTxAck.NewWithIdentifiersAndData(ctx, gtw, err))
	}
	errorLabel := "unknown"
	if ttnErr, ok := errors.From(err); ok {
		errorLabel = ttnErr.FullName()
	}
	ioMetrics.droppedMessages.WithLabelValues(ctx, typ, errorLabel).Inc()
}

func init() {
	metrics.MustRegister(ioMetrics)
}