Prevent NPE when generating snapshot metrics before initial cluster state is set #136350
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| pr: 136350 | ||
| summary: Prevent NPE when generating snapshot metrics before initial cluster state is set | ||
| area: Snapshot/Restore | ||
| type: bug | ||
| issues: [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the "Elastic License | ||
| * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side | ||
| * Public License v 1"; you may not use this file except in compliance with, at | ||
| * your election, the "Elastic License 2.0", the "GNU Affero General Public | ||
| * License v3.0 only", or the "Server Side Public License, v 1". | ||
| */ | ||
|
|
||
| package org.elasticsearch.snapshots; | ||
|
|
||
| import org.elasticsearch.cluster.ClusterState; | ||
| import org.elasticsearch.cluster.SnapshotsInProgress; | ||
| import org.elasticsearch.cluster.metadata.RepositoriesMetadata; | ||
| import org.elasticsearch.cluster.metadata.RepositoryMetadata; | ||
| import org.elasticsearch.cluster.service.ClusterService; | ||
| import org.elasticsearch.common.component.Lifecycle; | ||
| import org.elasticsearch.common.util.Maps; | ||
| import org.elasticsearch.core.Tuple; | ||
| import org.elasticsearch.repositories.SnapshotMetrics; | ||
| import org.elasticsearch.telemetry.metric.LongWithAttributes; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Generates the snapshots-by-state and shards-by-state metrics when polled. Only produces | ||
| * metrics on the master node, and only while the {@link ClusterService} is started. Will only | ||
| * re-calculate the metrics if the {@link SnapshotsInProgress} has changed since the last time | ||
| * they were calculated. | ||
| */ | ||
| public class CachingSnapshotAndShardByStateMetricsService { | ||
|
There was a problem hiding this comment. This could also probably be added to the |
||
|
|
||
| private final ClusterService clusterService; | ||
| private CachedSnapshotStateMetrics cachedSnapshotStateMetrics; | ||
|
There was a problem hiding this comment. Are we guaranteed that the metrics requests all come from the same thread (or at least, each one strictly happens-before the next)? If not, this should be |
||
|
|
||
| public CachingSnapshotAndShardByStateMetricsService(ClusterService clusterService) { | ||
| this.clusterService = clusterService; | ||
| } | ||
|
|
||
| public Collection<LongWithAttributes> getShardsByState() { | ||
| if (clusterService.lifecycleState() != Lifecycle.State.STARTED) { | ||
| return List.of(); | ||
| } | ||
|
Comment on lines
+44
to
+46
|
||
| final ClusterState state = clusterService.state(); | ||
| if (state.nodes().isLocalNodeElectedMaster() == false) { | ||
| // Only the master should report on shards-by-state | ||
| return List.of(); | ||
| } | ||
| return recalculateIfStale(state).shardStateMetrics(); | ||
| } | ||
|
|
||
| public Collection<LongWithAttributes> getSnapshotsByState() { | ||
| if (clusterService.lifecycleState() != Lifecycle.State.STARTED) { | ||
| return List.of(); | ||
| } | ||
| final ClusterState state = clusterService.state(); | ||
| if (state.nodes().isLocalNodeElectedMaster() == false) { | ||
| // Only the master should report on snapshots-by-state | ||
| return List.of(); | ||
| } | ||
| return recalculateIfStale(state).snapshotStateMetrics(); | ||
| } | ||
|
|
||
| private CachedSnapshotStateMetrics recalculateIfStale(ClusterState currentState) { | ||
| if (cachedSnapshotStateMetrics == null || cachedSnapshotStateMetrics.isStale(currentState)) { | ||
| cachedSnapshotStateMetrics = recalculateSnapshotStats(currentState); | ||
| } | ||
| return cachedSnapshotStateMetrics; | ||
| } | ||
|
|
||
| private CachedSnapshotStateMetrics recalculateSnapshotStats(ClusterState currentState) { | ||
| final SnapshotsInProgress snapshotsInProgress = SnapshotsInProgress.get(currentState); | ||
| final List<LongWithAttributes> snapshotStateMetrics = new ArrayList<>(); | ||
| final List<LongWithAttributes> shardStateMetrics = new ArrayList<>(); | ||
|
|
||
| currentState.metadata().projects().forEach((projectId, project) -> { | ||
| final RepositoriesMetadata repositoriesMetadata = RepositoriesMetadata.get(project); | ||
| if (repositoriesMetadata != null) { | ||
| for (RepositoryMetadata repository : repositoriesMetadata.repositories()) { | ||
| final Tuple<Map<SnapshotsInProgress.State, Integer>, Map<SnapshotsInProgress.ShardState, Integer>> stateSummaries = | ||
| snapshotsInProgress.shardStateSummaryForRepository(projectId, repository.name()); | ||
| final Map<String, Object> attributesMap = SnapshotMetrics.createAttributesMap(projectId, repository); | ||
| stateSummaries.v1() | ||
| .forEach( | ||
| (snapshotState, count) -> snapshotStateMetrics.add( | ||
| new LongWithAttributes(count, Maps.copyMapWithAddedEntry(attributesMap, "state", snapshotState.name())) | ||
| ) | ||
| ); | ||
| stateSummaries.v2() | ||
| .forEach( | ||
| (shardState, count) -> shardStateMetrics.add( | ||
| new LongWithAttributes(count, Maps.copyMapWithAddedEntry(attributesMap, "state", shardState.name())) | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
| }); | ||
| return new CachedSnapshotStateMetrics(currentState, snapshotStateMetrics, shardStateMetrics); | ||
| } | ||
|
|
||
| /** | ||
| * A cached copy of the snapshot and shard state metrics | ||
| */ | ||
| private record CachedSnapshotStateMetrics( | ||
| String clusterStateId, | ||
| int snapshotsInProgressIdentityHashcode, | ||
| Collection<LongWithAttributes> snapshotStateMetrics, | ||
| Collection<LongWithAttributes> shardStateMetrics | ||
| ) { | ||
| CachedSnapshotStateMetrics( | ||
| ClusterState sourceState, | ||
| Collection<LongWithAttributes> snapshotStateMetrics, | ||
| Collection<LongWithAttributes> shardStateMetrics | ||
| ) { | ||
| this( | ||
| sourceState.stateUUID(), | ||
| System.identityHashCode(SnapshotsInProgress.get(sourceState)), | ||
| snapshotStateMetrics, | ||
| shardStateMetrics | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Are these metrics stale? | ||
| * | ||
| * @param currentClusterState The current cluster state | ||
| * @return true if these metrics were calculated from a prior {@link SnapshotsInProgress} and need to be recalculated, false | ||
| * otherwise | ||
| */ | ||
| public boolean isStale(ClusterState currentClusterState) { | ||
| return System.identityHashCode(SnapshotsInProgress.get(currentClusterState)) != snapshotsInProgressIdentityHashcode; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This behaviour (creation of the gauges) isn't tested in new code, but there are integration tests for these metrics already.