forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-34457] Rename options for latency tracking
- Loading branch information
Showing
16 changed files
with
169 additions
and
69 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
36 changes: 36 additions & 0 deletions
36
docs/layouts/shortcodes/generated/state_latency_tracking_section.html
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,36 @@ | ||
| <table class="configuration table table-bordered"> | ||
| <thead> | ||
| <tr> | ||
| <th class="text-left" style="width: 20%">Key</th> | ||
| <th class="text-left" style="width: 15%">Default</th> | ||
| <th class="text-left" style="width: 10%">Type</th> | ||
| <th class="text-left" style="width: 55%">Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td><h5>state.latency-track.history-size</h5></td> | ||
| <td style="word-wrap: break-word;">128</td> | ||
| <td>Integer</td> | ||
| <td>Defines the number of measured latencies to maintain at each state access operation.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><h5>state.latency-track.keyed-state-enabled</h5></td> | ||
| <td style="word-wrap: break-word;">false</td> | ||
| <td>Boolean</td> | ||
| <td>Whether to track latency of keyed state operations, e.g value state put/get/clear.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><h5>state.latency-track.sample-interval</h5></td> | ||
| <td style="word-wrap: break-word;">100</td> | ||
| <td>Integer</td> | ||
| <td>The sample interval of latency track once 'state.latency-track.keyed-state-enabled' is enabled. The default value is 100, which means we would track the latency every 100 access requests.</td> | ||
| </tr> | ||
| <tr> | ||
| <td><h5>state.latency-track.state-name-as-variable</h5></td> | ||
| <td style="word-wrap: break-word;">true</td> | ||
| <td>Boolean</td> | ||
| <td>Whether to expose state name as a variable if tracking latency.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
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
68 changes: 68 additions & 0 deletions
68
flink-core/src/main/java/org/apache/flink/configuration/StateLatencyTrackOptions.java
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,68 @@ | ||
| /* | ||
| * 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.flink.configuration; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
| import org.apache.flink.annotation.docs.Documentation; | ||
|
|
||
| /** | ||
| * A collection of all configuration options that relate to the latency tracking for state access. | ||
| */ | ||
| @PublicEvolving | ||
| public class StateLatencyTrackOptions { | ||
|
|
||
| @Documentation.Section(Documentation.Sections.STATE_LATENCY_TRACKING) | ||
| public static final ConfigOption<Boolean> LATENCY_TRACK_ENABLED = | ||
| ConfigOptions.key("state.latency-track.keyed-state-enabled") | ||
| .booleanType() | ||
| .defaultValue(false) | ||
| .withDeprecatedKeys("state.backend.latency-track.keyed-state-enabled") | ||
| .withDescription( | ||
| "Whether to track latency of keyed state operations, e.g value state put/get/clear."); | ||
|
|
||
| @Documentation.Section(Documentation.Sections.STATE_LATENCY_TRACKING) | ||
| public static final ConfigOption<Integer> LATENCY_TRACK_SAMPLE_INTERVAL = | ||
| ConfigOptions.key("state.latency-track.sample-interval") | ||
| .intType() | ||
| .defaultValue(100) | ||
| .withDeprecatedKeys("state.backend.latency-track.sample-interval") | ||
| .withDescription( | ||
| String.format( | ||
| "The sample interval of latency track once '%s' is enabled. " | ||
| + "The default value is 100, which means we would track the latency every 100 access requests.", | ||
| LATENCY_TRACK_ENABLED.key())); | ||
|
|
||
| @Documentation.Section(Documentation.Sections.STATE_LATENCY_TRACKING) | ||
| public static final ConfigOption<Integer> LATENCY_TRACK_HISTORY_SIZE = | ||
| ConfigOptions.key("state.latency-track.history-size") | ||
| .intType() | ||
| .defaultValue(128) | ||
| .withDeprecatedKeys("state.backend.latency-track.history-size") | ||
| .withDescription( | ||
| "Defines the number of measured latencies to maintain at each state access operation."); | ||
|
|
||
| @Documentation.Section(Documentation.Sections.STATE_LATENCY_TRACKING) | ||
| public static final ConfigOption<Boolean> LATENCY_TRACK_STATE_NAME_AS_VARIABLE = | ||
| ConfigOptions.key("state.latency-track.state-name-as-variable") | ||
| .booleanType() | ||
| .defaultValue(true) | ||
| .withDeprecatedKeys("state.backend.latency-track.state-name-as-variable") | ||
| .withDescription( | ||
| "Whether to expose state name as a variable if tracking latency."); | ||
| } |
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
Oops, something went wrong.