commongrpc

Overview ¶

Package commongrpc provides helpers for creating and managing gRPC clients with support for connection pooling, telemetry instrumentation, keepalive configuration, and secure or insecure transport credentials (including mTLS).

It is designed to integrate with the common configuration model (commoncfg), connection pooling (grpcpool), and OpenTelemetry stats handlers (otlp).

Typical usage:

cfg := &commoncfg.GRPCClient{
    Address: "localhost:50051",
    Pool: commoncfg.GRPCPool{
        InitialCapacity: 2,
        MaxCapacity:     10,
    },
    Attributes: commoncfg.GRPCKeepalive{
        KeepaliveTime:    10 * time.Second,
        KeepaliveTimeout: 5 * time.Second,
    },
    SecretRef: &commoncfg.SecretRef{
        Type: commoncfg.MTLSSecretType,
        MTLS: commoncfg.MTLSSecret{ /* paths to certs */ },
    },
}

// Using a pooled client
myClient := NewMyServiceClient()
if err := commongrpc.NewPooledClient(myClient, cfg); err != nil {
    log.Fatalf("failed to init client: %v", err)
}

// Or using a single client connection
conn, err := commongrpc.NewClient(cfg)
if err != nil {
    log.Fatalf("failed to dial: %v", err)
}
defer conn.Close()

Package commongrpc provides helpers for creating and managing gRPC clients with support for connection pooling, telemetry, and secure mTLS credential management.

One of the core features of this package is the ability to automatically refresh gRPC client connections when underlying TLS certificates or keys are updated on disk. This enables long-lived clients to handle certificate rotation without downtime.

Typical usage:

cfg := &commoncfg.GRPCClient{
    Address: "my-grpc-server:443",
    SecretRef: &commoncfg.SecretRef{
        .....
    },
}

client, err := commongrpc.NewDynamicClientConn(cfg, 2*time.Second)
if err != nil {
    log.Fatalf("failed to create grpc client: %v", err)
}
defer client.Close()

grpcConn := client.ClientConn
myService := pb.NewMyServiceClient(grpcConn)