Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-22528][docs] Document latency tracking metrics for state accesses #16177

Merged
merged 1 commit into from
Jul 2, 2021

Conversation

Myasuka
Copy link
Member

@Myasuka Myasuka commented Jun 17, 2021

What is the purpose of the change

Add document of latency tracking metrics for state accesses.

Brief change log

Add document of latency tracking metrics for state accesses.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? yes
  • If yes, how is the feature documented? docs

@flinkbot
Copy link
Collaborator

flinkbot commented Jun 17, 2021

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 0b171c5 (Thu Sep 23 17:54:59 UTC 2021)

✅no warnings

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Jun 17, 2021

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build

@tillrohrmann
Copy link
Contributor

Thanks for creating this documentation PR @Myasuka. Has this PR already been reviewed by @carp84?

@Myasuka
Copy link
Member Author

Myasuka commented Jun 25, 2021

@rkhachatryan , would you please take a look at this PR?

Copy link
Contributor

@rkhachatryan rkhachatryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @Myasuka

I've made some suggestions, PTAL.

docs/content.zh/docs/ops/metrics.md Outdated Show resolved Hide resolved
docs/content.zh/docs/ops/metrics.md Outdated Show resolved Hide resolved
@tillrohrmann
Copy link
Contributor

Maybe @infoverload you also wanna take a look at this documentation PR.

@@ -561,6 +561,17 @@ val counts: DataStream[(String, Int)] = stream
})
```

### 跟踪 keyed state 的访问延迟

Flink also allows to track the keyed state access latency for all state-backends. This feature is disabled by default.
Copy link
Contributor

@infoverload infoverload Jun 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Flink also allows to track the keyed state access latency for all state-backends. This feature is disabled by default.
Flink also allows tracking the keyed state access latency for all state backends. This feature is disabled by default.

same for English version

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be okay and this also existed in many places within Flink's docs.

@@ -1642,7 +1642,7 @@ logged by `SystemResourcesMetricsInitializer` during the startup.
</tbody>
</table>

## Latency tracking
## End-to-End record travelling latency tracking

Flink allows to track the latency of records travelling through the system. This feature is disabled by default.
Copy link
Contributor

@infoverload infoverload Jun 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Flink allows to track the latency of records travelling through the system. This feature is disabled by default.
Flink allows tracking the latency of records travelling through the system. This feature is disabled by default.

same for English version

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be okay and this also existed in many places within Flink's docs.

Copy link
Contributor

@rkhachatryan rkhachatryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the PR, I don't have any further concerns.

@Myasuka
Copy link
Member Author

Myasuka commented Jul 2, 2021

Thanks for @rkhachatryan 's review, merging...

@Myasuka Myasuka merged commit 9e3b09d into apache:master Jul 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants