forked from cadence-workflow/cadence
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Metric Emitter, which emits a metric once a minute for true repli…
…cation lag in nanoseconds. (cadence-workflow#4979)
- Loading branch information
Showing
6 changed files
with
310 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,170 @@ | ||
| // The MIT License (MIT) | ||
|
|
||
| // Copyright (c) 2017-2020 Uber Technologies Inc. | ||
|
|
||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| package replication | ||
|
|
||
| import ( | ||
| ctx "context" | ||
| "fmt" | ||
| "strconv" | ||
| "sync/atomic" | ||
| "time" | ||
|
|
||
| "github.com/uber/cadence/common/config" | ||
|
|
||
| "github.com/uber/cadence/common/clock" | ||
| "github.com/uber/cadence/common/cluster" | ||
|
|
||
| "github.com/uber/cadence/common" | ||
| "github.com/uber/cadence/common/log" | ||
| "github.com/uber/cadence/common/log/tag" | ||
| "github.com/uber/cadence/common/metrics" | ||
| ) | ||
|
|
||
| const ( | ||
| metricsEmissionInterval = time.Minute | ||
| ) | ||
|
|
||
| type ( | ||
| // MetricsEmitterImpl is responsible for emitting source side replication metrics occasionally. | ||
| MetricsEmitterImpl struct { | ||
| shardID int | ||
| currentCluster string | ||
| remoteClusters map[string]config.ClusterInformation | ||
| shardData metricsEmitterShardData | ||
| reader taskReader | ||
| scope metrics.Scope | ||
| logger log.Logger | ||
| status int32 | ||
| done chan struct{} | ||
| } | ||
|
|
||
| // metricsEmitterShardData is for testing. | ||
| metricsEmitterShardData interface { | ||
| GetLogger() log.Logger | ||
| GetClusterMetadata() cluster.Metadata | ||
| GetClusterReplicationLevel(cluster string) int64 | ||
| GetTimeSource() clock.TimeSource | ||
| } | ||
| ) | ||
|
|
||
| // NewMetricsEmitter creates a new metrics emitter, which starts a goroutine to emit replication metrics occasionally. | ||
| func NewMetricsEmitter( | ||
| shardID int, | ||
| shardData metricsEmitterShardData, | ||
| reader taskReader, | ||
| metricsClient metrics.Client, | ||
| ) *MetricsEmitterImpl { | ||
| currentCluster := shardData.GetClusterMetadata().GetCurrentClusterName() | ||
| remoteClusters := shardData.GetClusterMetadata().GetRemoteClusterInfo() | ||
|
|
||
| scope := metricsClient.Scope( | ||
| metrics.ReplicationMetricEmitterScope, | ||
| metrics.ActiveClusterTag(currentCluster), | ||
| metrics.InstanceTag(strconv.Itoa(shardID)), | ||
| ) | ||
| logger := shardData.GetLogger().WithTags( | ||
| tag.ClusterName(currentCluster), | ||
| tag.ShardID(shardID)) | ||
|
|
||
| return &MetricsEmitterImpl{ | ||
| shardID: shardID, | ||
| currentCluster: currentCluster, | ||
| remoteClusters: remoteClusters, | ||
| status: common.DaemonStatusInitialized, | ||
| shardData: shardData, | ||
| reader: reader, | ||
| scope: scope, | ||
| logger: logger, | ||
| done: make(chan struct{}), | ||
| } | ||
| } | ||
|
|
||
| func (m *MetricsEmitterImpl) Start() { | ||
| if !atomic.CompareAndSwapInt32(&m.status, common.DaemonStatusInitialized, common.DaemonStatusStarted) { | ||
| return | ||
| } | ||
|
|
||
| go m.emitMetricsLoop() | ||
| m.logger.Info("ReplicationMetricsEmitter started.") | ||
| } | ||
|
|
||
| func (m *MetricsEmitterImpl) Stop() { | ||
| if !atomic.CompareAndSwapInt32(&m.status, common.DaemonStatusStarted, common.DaemonStatusStopped) { | ||
| return | ||
| } | ||
|
|
||
| m.logger.Info("ReplicationMetricsEmitter shutting down.") | ||
| close(m.done) | ||
| } | ||
|
|
||
| func (m *MetricsEmitterImpl) emitMetricsLoop() { | ||
| ticker := time.NewTicker(metricsEmissionInterval) | ||
| defer ticker.Stop() | ||
| defer func() { log.CapturePanic(recover(), m.logger, nil) }() | ||
|
|
||
| for { | ||
| select { | ||
| case <-m.done: | ||
| return | ||
| case <-ticker.C: | ||
| m.emitMetrics() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (m *MetricsEmitterImpl) emitMetrics() { | ||
| for remoteClusterName := range m.remoteClusters { | ||
| logger := m.logger.WithTags(tag.RemoteCluster(remoteClusterName)) | ||
| scope := m.scope.Tagged(metrics.TargetClusterTag(remoteClusterName)) | ||
|
|
||
| replicationLatency, err := m.determineReplicationLatency(remoteClusterName) | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| scope.UpdateGauge(metrics.ReplicationLatency, float64(replicationLatency.Nanoseconds())) | ||
| logger.Debug(fmt.Sprintf("ReplicationLatency metric emitted: %v", float64(replicationLatency.Nanoseconds()))) | ||
| } | ||
| } | ||
|
|
||
| func (m *MetricsEmitterImpl) determineReplicationLatency(remoteClusterName string) (time.Duration, error) { | ||
| logger := m.logger.WithTags(tag.RemoteCluster(remoteClusterName)) | ||
| lastReadTaskID := m.shardData.GetClusterReplicationLevel(remoteClusterName) | ||
|
|
||
| tasks, _, err := m.reader.Read(ctx.Background(), lastReadTaskID, lastReadTaskID+1) | ||
| if err != nil { | ||
| logger.Error(fmt.Sprintf( | ||
| "Error reading when determining replication latency, lastReadTaskID=%v", lastReadTaskID), | ||
| tag.Error(err)) | ||
| return 0, err | ||
| } | ||
| logger.Debug("Number of tasks retrieved", tag.Number(int64(len(tasks)))) | ||
|
|
||
| var replicationLatency time.Duration | ||
| if len(tasks) > 0 { | ||
| creationTime := time.Unix(0, tasks[0].CreationTime) | ||
| replicationLatency = m.shardData.GetTimeSource().Now().Sub(creationTime) | ||
| } | ||
|
|
||
| return replicationLatency, nil | ||
| } |
This file contains 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,119 @@ | ||
| // The MIT License (MIT) | ||
|
|
||
| // Copyright (c) 2017-2020 Uber Technologies Inc. | ||
|
|
||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| package replication | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/uber/cadence/common/clock" | ||
| "github.com/uber/cadence/common/cluster" | ||
| "github.com/uber/cadence/common/config" | ||
| "github.com/uber/cadence/common/log" | ||
| "github.com/uber/cadence/common/metrics" | ||
| "github.com/uber/cadence/common/persistence" | ||
| ) | ||
|
|
||
| var ( | ||
| cluster1 = "cluster1" | ||
| cluster2 = "cluster2" | ||
| cluster3 = "cluster3" | ||
| ) | ||
|
|
||
| func TestMetricsEmitter(t *testing.T) { | ||
| timeSource := clock.NewEventTimeSource() | ||
| metadata := cluster.NewMetadata(0, cluster1, cluster1, map[string]config.ClusterInformation{ | ||
| cluster1: {Enabled: true}, | ||
| cluster2: {Enabled: true}, | ||
| cluster3: {Enabled: true}, | ||
| }) | ||
| testShardData := newTestShardData(timeSource, metadata) | ||
| timeSource.Update(time.Unix(10000, 0)) | ||
|
|
||
| task1 := persistence.ReplicationTaskInfo{TaskID: 1, CreationTime: timeSource.Now().Add(-time.Hour).UnixNano()} | ||
| task2 := persistence.ReplicationTaskInfo{TaskID: 2, CreationTime: timeSource.Now().Add(-time.Minute).UnixNano()} | ||
| reader := fakeTaskReader{&task1, &task2} | ||
|
|
||
| metricsEmitter := NewMetricsEmitter(1, testShardData, reader, metrics.NewNoopMetricsClient()) | ||
| latency, err := metricsEmitter.determineReplicationLatency(cluster2) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, time.Hour, latency) | ||
|
|
||
| // Move replication level up for cluster2 and our latency shortens | ||
| testShardData.clusterReplicationLevel[cluster2] = 2 | ||
| latency, err = metricsEmitter.determineReplicationLatency(cluster2) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, time.Minute, latency) | ||
|
|
||
| // Move replication level up for cluster2 and we no longer have latency | ||
| testShardData.clusterReplicationLevel[cluster2] = 3 | ||
| latency, err = metricsEmitter.determineReplicationLatency(cluster2) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, time.Duration(0), latency) | ||
|
|
||
| // Cluster3 will still have latency | ||
| latency, err = metricsEmitter.determineReplicationLatency(cluster3) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, time.Hour, latency) | ||
| } | ||
|
|
||
| type testShardData struct { | ||
| shardID int | ||
| logger log.Logger | ||
| maxReadLevel int64 | ||
| clusterReplicationLevel map[string]int64 | ||
| timeSource clock.TimeSource | ||
| metadata cluster.Metadata | ||
| } | ||
|
|
||
| func newTestShardData(timeSource clock.TimeSource, metadata cluster.Metadata) testShardData { | ||
| remotes := metadata.GetRemoteClusterInfo() | ||
| clusterReplicationLevels := make(map[string]int64, len(remotes)) | ||
| for remote := range remotes { | ||
| clusterReplicationLevels[remote] = 1 | ||
| } | ||
| return testShardData{ | ||
| logger: log.NewNoop(), | ||
| timeSource: timeSource, | ||
| metadata: metadata, | ||
| clusterReplicationLevel: clusterReplicationLevels, | ||
| } | ||
| } | ||
|
|
||
| func (t testShardData) GetLogger() log.Logger { | ||
| return t.logger | ||
| } | ||
|
|
||
| func (t testShardData) GetClusterReplicationLevel(cluster string) int64 { | ||
| return t.clusterReplicationLevel[cluster] | ||
| } | ||
|
|
||
| func (t testShardData) GetTimeSource() clock.TimeSource { | ||
| return t.timeSource | ||
| } | ||
|
|
||
| func (t testShardData) GetClusterMetadata() cluster.Metadata { | ||
| return t.metadata | ||
| } |