|
| 1 | +// Copyright The OpenTelemetry Authors |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package kafkametricsreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/kafkametricsreceiver" |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "fmt" |
| 9 | + "strconv" |
| 10 | + "time" |
| 11 | + |
| 12 | + "github.com/twmb/franz-go/pkg/kadm" |
| 13 | + "github.com/twmb/franz-go/pkg/kgo" |
| 14 | + "go.opentelemetry.io/collector/component" |
| 15 | + "go.opentelemetry.io/collector/pdata/pcommon" |
| 16 | + "go.opentelemetry.io/collector/pdata/pmetric" |
| 17 | + "go.opentelemetry.io/collector/receiver" |
| 18 | + "go.opentelemetry.io/collector/scraper" |
| 19 | + "go.opentelemetry.io/collector/scraper/scrapererror" |
| 20 | + "go.uber.org/zap" |
| 21 | + |
| 22 | + "github.com/open-telemetry/opentelemetry-collector-contrib/internal/kafka" |
| 23 | + "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/kafkametricsreceiver/internal/metadata" |
| 24 | +) |
| 25 | + |
| 26 | +type brokerScraperFranz struct { |
| 27 | + // franz-go handles (lazy created on first scrape) |
| 28 | + adm *kadm.Client |
| 29 | + cl *kgo.Client |
| 30 | + |
| 31 | + settings receiver.Settings |
| 32 | + config Config |
| 33 | + mb *metadata.MetricsBuilder |
| 34 | +} |
| 35 | + |
| 36 | +func (s *brokerScraperFranz) start(_ context.Context, _ component.Host) error { |
| 37 | + s.mb = metadata.NewMetricsBuilder(s.config.MetricsBuilderConfig, s.settings) |
| 38 | + return nil |
| 39 | +} |
| 40 | + |
| 41 | +func (s *brokerScraperFranz) shutdown(context.Context) error { |
| 42 | + if s.adm != nil { |
| 43 | + s.adm.Close() |
| 44 | + s.adm = nil |
| 45 | + } |
| 46 | + if s.cl != nil { |
| 47 | + s.cl.Close() |
| 48 | + s.cl = nil |
| 49 | + } |
| 50 | + return nil |
| 51 | +} |
| 52 | + |
| 53 | +func (s *brokerScraperFranz) ensureClients(ctx context.Context) error { |
| 54 | + if s.cl != nil && s.adm != nil { |
| 55 | + return nil |
| 56 | + } |
| 57 | + adm, cl, err := kafka.NewFranzClusterAdminClient(ctx, s.config.ClientConfig, s.settings.Logger) |
| 58 | + if err != nil { |
| 59 | + return fmt.Errorf("failed to create franz-go admin client: %w", err) |
| 60 | + } |
| 61 | + s.adm = adm |
| 62 | + s.cl = cl |
| 63 | + return nil |
| 64 | +} |
| 65 | + |
| 66 | +func (s *brokerScraperFranz) scrape(ctx context.Context) (pmetric.Metrics, error) { |
| 67 | + scrapeErrs := scrapererror.ScrapeErrors{} |
| 68 | + |
| 69 | + if err := s.ensureClients(ctx); err != nil { |
| 70 | + return pmetric.Metrics{}, err |
| 71 | + } |
| 72 | + |
| 73 | + now := pcommon.NewTimestampFromTime(time.Now()) |
| 74 | + rb := s.mb.NewResourceBuilder() |
| 75 | + rb.SetKafkaClusterAlias(s.config.ClusterAlias) |
| 76 | + |
| 77 | + // ---- brokers count ---- |
| 78 | + bdetails, err := s.adm.ListBrokers(ctx) |
| 79 | + if err != nil { |
| 80 | + // If we cannot list brokers, emit what we have (resource attrs) and return the error |
| 81 | + scrapeErrs.Add(err) |
| 82 | + return s.mb.Emit(metadata.WithResource(rb.Emit())), scrapeErrs.Combine() |
| 83 | + } |
| 84 | + brokerIDs := bdetails.NodeIDs() |
| 85 | + s.mb.RecordKafkaBrokersDataPoint(now, int64(len(brokerIDs))) |
| 86 | + |
| 87 | + // If log retention metric is disabled, we are done. |
| 88 | + if !s.config.Metrics.KafkaBrokerLogRetentionPeriod.Enabled { |
| 89 | + return s.mb.Emit(metadata.WithResource(rb.Emit())), scrapeErrs.Combine() |
| 90 | + } |
| 91 | + |
| 92 | + res, err := s.adm.DescribeBrokerConfigs(ctx, brokerIDs...) |
| 93 | + if err != nil { |
| 94 | + s.settings.Logger.Warn("franz-go: DescribeBrokerConfigs failed", zap.Error(err)) |
| 95 | + scrapeErrs.AddPartial(len(brokerIDs), fmt.Errorf("DescribeBrokerConfigs: %w", err)) |
| 96 | + } |
| 97 | + |
| 98 | + // Iterate the result and record the metric for each broker entry we can parse. |
| 99 | + for _, bid := range brokerIDs { |
| 100 | + bidStr := strconv.Itoa(int(bid)) |
| 101 | + |
| 102 | + // Look up this broker's config set by resource name (broker id as string). |
| 103 | + cfg, _ := res.On(bidStr, nil) // fn can be nil to just return the entry |
| 104 | + if cfg.Err != nil { |
| 105 | + scrapeErrs.AddPartial(1, fmt.Errorf("broker %s: %w", bidStr, cfg.Err)) |
| 106 | + continue |
| 107 | + } |
| 108 | + |
| 109 | + for _, kv := range cfg.Configs { |
| 110 | + // kadm.Config has Key and MaybeValue() for the string value. |
| 111 | + // We only care about log.retention.hours here. |
| 112 | + if kv.Key != logRetentionHours { |
| 113 | + continue |
| 114 | + } |
| 115 | + raw := kv.MaybeValue() |
| 116 | + hrs, convErr := strconv.Atoi(raw) |
| 117 | + if convErr != nil { |
| 118 | + scrapeErrs.AddPartial(1, fmt.Errorf("broker %s: cannot parse %s=%q: %w", bidStr, logRetentionHours, raw, convErr)) |
| 119 | + continue |
| 120 | + } |
| 121 | + sec := int64(hrs) * 3600 |
| 122 | + s.mb.RecordKafkaBrokerLogRetentionPeriodDataPoint(now, sec, bidStr) |
| 123 | + } |
| 124 | + } |
| 125 | + |
| 126 | + return s.mb.Emit(metadata.WithResource(rb.Emit())), scrapeErrs.Combine() |
| 127 | +} |
| 128 | + |
| 129 | +// factory for franz-go scraper (internal; selected via gate at the call site later) |
| 130 | +func createBrokerScraperFranz(_ context.Context, cfg Config, settings receiver.Settings) (scraper.Metrics, error) { |
| 131 | + s := &brokerScraperFranz{ |
| 132 | + settings: settings, |
| 133 | + config: cfg, |
| 134 | + } |
| 135 | + return scraper.NewMetrics( |
| 136 | + s.scrape, |
| 137 | + scraper.WithStart(s.start), |
| 138 | + scraper.WithShutdown(s.shutdown), |
| 139 | + ) |
| 140 | +} |
0 commit comments