eolivelli commented on code in PR #13833: URL: https://github.com/apache/pulsar/pull/13833#discussion_r849123883
########## managed-ledger/src/main/java/org/apache/bookkeeper/mledger/impl/LedgerOffloaderStatsImpl.java: ########## @@ -0,0 +1,303 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.bookkeeper.mledger.impl; + +import com.google.common.annotations.VisibleForTesting; +import io.prometheus.client.CollectorRegistry; +import io.prometheus.client.Counter; +import io.prometheus.client.Gauge; +import io.prometheus.client.Summary; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.LongAdder; +import java.util.stream.Collectors; +import org.apache.bookkeeper.mledger.LedgerOffloaderStats; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.tuple.ImmutablePair; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.pulsar.common.naming.TopicName; + +public final class LedgerOffloaderStatsImpl implements LedgerOffloaderStats, Runnable { + private static final String TOPIC_LABEL = "topic"; + private static final String NAMESPACE_LABEL = "namespace"; + private static final String UNKNOWN = "unknown"; + private static final String STATUS = "status"; + private static final String SUCCEED = "succeed"; + private static final String FAILED = "failed"; + + private final boolean exposeTopicLevelMetrics; + private final int interval; + + private final Counter offloadError; + private final Gauge offloadRate; + private final Counter deleteOffloadOps; + private final Summary readLedgerLatency; + private final Counter writeStorageError; + private final Counter readOffloadError; + private final Gauge readOffloadRate; + private final Summary readOffloadIndexLatency; + private final Summary readOffloadDataLatency; + + private final Map<String, String> topic2Namespace; Review Comment: we have to update these Maps (topic2Namespace and offloadAndReadOffloadBytesMap) when we "unload" a topic, otherwise the Map will continue to grow and we will be also publishing data for topics that are not owned by the local broker ########## managed-ledger/src/main/java/org/apache/bookkeeper/mledger/impl/LedgerOffloaderStatsImpl.java: ########## @@ -0,0 +1,303 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.bookkeeper.mledger.impl; + +import com.google.common.annotations.VisibleForTesting; +import io.prometheus.client.CollectorRegistry; +import io.prometheus.client.Counter; +import io.prometheus.client.Gauge; +import io.prometheus.client.Summary; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.LongAdder; +import java.util.stream.Collectors; +import org.apache.bookkeeper.mledger.LedgerOffloaderStats; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.tuple.ImmutablePair; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.pulsar.common.naming.TopicName; + +public final class LedgerOffloaderStatsImpl implements LedgerOffloaderStats, Runnable { + private static final String TOPIC_LABEL = "topic"; + private static final String NAMESPACE_LABEL = "namespace"; + private static final String UNKNOWN = "unknown"; + private static final String STATUS = "status"; + private static final String SUCCEED = "succeed"; + private static final String FAILED = "failed"; + + private final boolean exposeTopicLevelMetrics; + private final int interval; + + private final Counter offloadError; + private final Gauge offloadRate; + private final Counter deleteOffloadOps; + private final Summary readLedgerLatency; + private final Counter writeStorageError; + private final Counter readOffloadError; + private final Gauge readOffloadRate; + private final Summary readOffloadIndexLatency; + private final Summary readOffloadDataLatency; + + private final Map<String, String> topic2Namespace; + private final Map<String, Pair<LongAdder, LongAdder>> offloadAndReadOffloadBytesMap; + + final AtomicBoolean closed = new AtomicBoolean(false); + + private LedgerOffloaderStatsImpl(boolean exposeTopicLevelMetrics, + ScheduledExecutorService scheduler, int interval) { + this.interval = interval; + this.exposeTopicLevelMetrics = exposeTopicLevelMetrics; + if (null != scheduler) { + scheduler.scheduleAtFixedRate(this, interval, interval, TimeUnit.SECONDS); + } + + this.topic2Namespace = new ConcurrentHashMap<>(); + this.offloadAndReadOffloadBytesMap = new ConcurrentHashMap<>(); + + String[] labels = exposeTopicLevelMetrics + ? new String[]{NAMESPACE_LABEL, TOPIC_LABEL} : new String[]{NAMESPACE_LABEL}; + + this.offloadError = Counter.build("brk_ledgeroffloader_offload_error", "-") + .labelNames(labels).create().register(); + this.offloadRate = Gauge.build("brk_ledgeroffloader_offload_rate", "-") + .labelNames(labels).create().register(); + + this.readOffloadError = Counter.build("brk_ledgeroffloader_read_offload_error", "-") + .labelNames(labels).create().register(); + this.readOffloadRate = Gauge.build("brk_ledgeroffloader_read_offload_rate", "-") + .labelNames(labels).create().register(); + this.writeStorageError = Counter.build("brk_ledgeroffloader_write_storage_error", "-") + .labelNames(labels).create().register(); + + this.readOffloadIndexLatency = Summary.build("brk_ledgeroffloader_read_offload_index_latency", "-") + .labelNames(labels).create().register(); + this.readOffloadDataLatency = Summary.build("brk_ledgeroffloader_read_offload_data_latency", "-") + .labelNames(labels).create().register(); + this.readLedgerLatency = Summary.build("brk_ledgeroffloader_read_ledger_latency", "-") + .labelNames(labels).create().register(); + + String[] deleteOpsLabels = exposeTopicLevelMetrics + ? new String[]{NAMESPACE_LABEL, TOPIC_LABEL, STATUS} : new String[]{NAMESPACE_LABEL, STATUS}; + this.deleteOffloadOps = Counter.build("brk_ledgeroffloader_delete_offload_ops", "-") + .labelNames(deleteOpsLabels).create().register(); + } + + + private static LedgerOffloaderStats instance; + public static synchronized LedgerOffloaderStats getInstance(boolean exposeTopicLevelMetrics, + ScheduledExecutorService scheduler, int interval) { + if (null == instance) { + instance = new LedgerOffloaderStatsImpl(exposeTopicLevelMetrics, scheduler, interval); + } + + return instance; + } + + @Override + public void recordOffloadError(String topic) { + String[] labelValues = this.labelValues(topic); + this.offloadError.labels(labelValues).inc(); + } + + @Override + public void recordOffloadBytes(String topic, long size) { + topic = StringUtils.isBlank(topic) ? UNKNOWN : topic; + Pair<LongAdder, LongAdder> pair = this.offloadAndReadOffloadBytesMap + .computeIfAbsent(topic, __ -> new ImmutablePair<>(new LongAdder(), new LongAdder())); + pair.getLeft().add(size); + } + + @Override + public void recordReadLedgerLatency(String topic, long latency, TimeUnit unit) { + String[] labelValues = this.labelValues(topic); + this.readLedgerLatency.labels(labelValues).observe(unit.toMicros(latency)); + } + + @Override + public void recordWriteToStorageError(String topic) { + String[] labelValues = this.labelValues(topic); + this.writeStorageError.labels(labelValues).inc(); + } + + @Override + public void recordReadOffloadError(String topic) { + String[] labelValues = this.labelValues(topic); + this.readOffloadError.labels(labelValues).inc(); + } + + @Override + public void recordReadOffloadBytes(String topic, long size) { + topic = StringUtils.isBlank(topic) ? UNKNOWN : topic; + Pair<LongAdder, LongAdder> pair = this.offloadAndReadOffloadBytesMap + .computeIfAbsent(topic, __ -> new ImmutablePair<>(new LongAdder(), new LongAdder())); + pair.getRight().add(size); + } + + @Override + public void recordReadOffloadIndexLatency(String topic, long latency, TimeUnit unit) { + String[] labelValues = this.labelValues(topic); + this.readOffloadIndexLatency.labels(labelValues).observe(unit.toMicros(latency)); + } + + @Override + public void recordReadOffloadDataLatency(String topic, long latency, TimeUnit unit) { + String[] labelValues = this.labelValues(topic); + this.readOffloadDataLatency.labels(labelValues).observe(unit.toMicros(latency)); + } + + @Override + public void recordDeleteOffloadOps(String topic, boolean succeed) { + String status = succeed ? SUCCEED : FAILED; + String[] labelValues = this.labelValues(topic, status); + this.deleteOffloadOps.labels(labelValues).inc(); + } + + + private String[] labelValues(String topic, String status) { + if (StringUtils.isBlank(topic)) { + return exposeTopicLevelMetrics ? new String[]{UNKNOWN, UNKNOWN, status} : new String[]{UNKNOWN, status}; + } + String namespace = this.getNamespace(topic); + return this.exposeTopicLevelMetrics ? new String[]{namespace, topic, status} : new String[]{namespace, status}; + } + + private String[] labelValues(String topic) { + if (StringUtils.isBlank(topic)) { + return this.exposeTopicLevelMetrics ? new String[]{UNKNOWN, UNKNOWN} : new String[]{UNKNOWN}; + } + String namespace = this.getNamespace(topic); + return this.exposeTopicLevelMetrics ? new String[]{namespace, topic} : new String[]{namespace}; + } + + private String getNamespace(String topic) { + return this.topic2Namespace.computeIfAbsent(topic, t -> { + try { + return TopicName.get(t).getNamespace(); + } catch (Throwable th) { Review Comment: can you please explain better the problem ? maybe we can catch specific Exceptions instead of a generic Throwable Throwable can be a OutOfMemoryError or any other error, so we are going to mask problems if the problem is about a IllegalArgumentException then just catch it Also, if the problem is in tests that call directly these methods then we can fix them My preference goes to catching specific exceptions (as maybe there can be some patch in which we are not passing a topic name, because here my understanding is that we are passing a "managed ledger name" (that is a superset of topic names) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
