Skip to content

RATIS-1704. Fix SuppressWarnings("VisibilityModifier") in RatisMetrics. #742

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.

Sign up for GitHub

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

Jump to bottom
Merged
codings-dan merged 2 commits into from
Sep 16, 2022
Merged

RATIS-1704. Fix SuppressWarnings("VisibilityModifier") in RatisMetrics. #742

codings-dan merged 2 commits into from
Sep 16, 2022

Conversation

@szetszwo
Copy link
Contributor

@szetszwo szetszwo commented Sep 10, 2022

codings-dan
codings-dan reviewed Sep 15, 2022
View reviewed changes
Copy link
Contributor

@codings-dan codings-dan left a comment

Choose a reason for hiding this comment

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

@szetszwo Thanks for working on this, just left some comments for reference

ratis-grpc/src/main/java/org/apache/ratis/grpc/metrics/MessageMetrics.java
private enum Type {
STARTED("_started_total"),
COMPLETED("_completed_total"),
RECEIVED("_received_executed");
Copy link
Contributor

@codings-dan codings-dan Sep 15, 2022

Choose a reason for hiding this comment

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

_received_executed -> _received_total or _received_executed_total

Copy link
Contributor Author

@szetszwo szetszwo Sep 15, 2022

Choose a reason for hiding this comment

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

@codings-dan , I also want to change some of the metrics names but it may break some external metrics applications. So, we are better to leave them unchanged.

Copy link
Contributor

@codings-dan codings-dan Sep 16, 2022

Choose a reason for hiding this comment

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

Got it, thanks!

ratis-grpc/src/main/java/org/apache/ratis/grpc/metrics/MessageMetrics.java Outdated
* Both client and server use this.
* @param rpcType
*/
public void rpcStarted(String rpcType){
Copy link
Contributor

@codings-dan codings-dan Sep 15, 2022

Choose a reason for hiding this comment

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

The variable name here is rpcType Inappropriate, I think it should be rpcName

Copy link
Contributor Author

@szetszwo szetszwo Sep 15, 2022

Choose a reason for hiding this comment

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

Let's use metricNamePrefix since the callers (e.g. MetricClientCall) use i.

ratis-grpc/src/main/java/org/apache/ratis/grpc/metrics/MessageMetrics.java Outdated

public MessageMetrics(String endpointId, String endpointType) {
this.registry = create(
super(create(
Copy link
Contributor

@codings-dan codings-dan Sep 15, 2022

Choose a reason for hiding this comment

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

Let's align with GrpcServerMetrics and create a new method

private static RatisMetricRegistry createRegistry(String endpointId) {
    return create(new MetricRegistryInfo(endpointId,
            RATIS_APPLICATION_NAME_METRICS,
            String.format(GRPC_MESSAGE_METRICS, endpointType),
            GRPC_MESSAGE_METRICS_DESC);
  }

Copy link
Contributor Author

@szetszwo szetszwo Sep 15, 2022

Choose a reason for hiding this comment

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

Sure.

ratis-server/src/main/java/org/apache/ratis/server/metrics/LeaderElectionMetrics.java Outdated
this.registry = getMetricRegistryForLeaderElection(serverId);
registry.gauge(LAST_LEADER_ELAPSED_TIME, () -> getLastLeaderElapsedTimeMs::getAsLong);
registry.gauge(LAST_LEADER_ELECTION_ELAPSED_TIME,
super(getMetricRegistryForLeaderElection(serverId));
Copy link
Contributor

@codings-dan codings-dan Sep 15, 2022

Choose a reason for hiding this comment

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

rename getMetricRegistryForLeaderElection -> createRegistry

Copy link
Contributor Author

@szetszwo szetszwo Sep 15, 2022

Choose a reason for hiding this comment

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

Done.

ratis-server/src/main/java/org/apache/ratis/server/metrics/RaftLogMetricsBase.java Outdated

public RaftLogMetricsBase(RaftGroupMemberId serverId) {
this.registry = getLogWorkerMetricRegistry(serverId);
super(getLogWorkerMetricRegistry(serverId));
Copy link
Contributor

@codings-dan codings-dan Sep 15, 2022

Choose a reason for hiding this comment

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

rename getLogWorkerMetricRegistry -> createRegistry

Copy link
Contributor Author

@szetszwo szetszwo Sep 15, 2022

Choose a reason for hiding this comment

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

Done.

ratis-netty/src/main/java/org/apache/ratis/netty/metrics/NettyServerStreamRpcMetrics.java Outdated

public NettyServerStreamRpcMetrics(String serverId) {
registry = getMetricRegistryForGrpcServer(serverId);
super(getMetricRegistryForGrpcServer(serverId));
Copy link
Contributor

@codings-dan codings-dan Sep 15, 2022

Choose a reason for hiding this comment

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

rename getMetricRegistryForGrpcServer -> createRegistry

Copy link
Contributor Author

@szetszwo szetszwo Sep 15, 2022

Choose a reason for hiding this comment

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

Done.

codings-dan
codings-dan approved these changes Sep 16, 2022
View reviewed changes
Copy link
Contributor

@codings-dan codings-dan left a comment

Choose a reason for hiding this comment

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

The change looks good, +1

@codings-dan codings-dan merged commit 8fbe434 into apache:master Sep 16, 2022
symious pushed a commit to symious/ratis that referenced this pull request Mar 11, 2024
@szetszwo @symious
RATIS-1704. Fix SuppressWarnings("VisibilityModifier") in RatisMetric…
4e4de36 
…s. (apache#742)

* RATIS-1704. Fix SuppressWarnings("VisibilityModifier") in RatisMetrics.

* Address review comments.
@SteNicholas SteNicholas mentioned this pull request Apr 24, 2024
Closed
RexXiong pushed a commit to apache/celeborn that referenced this pull request May 30, 2024
@SteNicholas @RexXiong
[CELEBORN-1400] Bump Ratis version from 2.5.1 to 3.0.1
2a57fab 
### What changes were proposed in this pull request?

Bump Ratis version from 2.5.1 to 3.0.1. Address incompatible changes:

- RATIS-589. Eliminate buffer copying in SegmentedRaftLogOutputStream.(apache/ratis#964)
- RATIS-1677. Do not auto format RaftStorage in RECOVER.(apache/ratis#718)
- RATIS-1710. Refactor metrics api and implementation to separated modules. (apache/ratis#749)

### Why are the changes needed?

Bump Ratis version from 2.5.1 to 3.0.1. Ratis has released v3.0.0, v3.0.1, which release note refers to [3.0.0](https://ratis.apache.org/post/3.0.0.html), [3.0.1](https://ratis.apache.org/post/3.0.1.html). The 3.0.x version include new features like pluggable metrics and lease read, etc, some improvements and bugfixes including:

- 3.0.0: Change list of ratis 3.0.0 In total, there are roughly 100 commits diffing from 2.5.1 including:
   - Incompatible Changes
      - RaftStorage Auto-Format
      - RATIS-1677. Do not auto format RaftStorage in RECOVER. (apache/ratis#718)
      - RATIS-1694. Fix the compatibility issue of RATIS-1677. (apache/ratis#731)
      - RATIS-1871. Auto format RaftStorage when there is only one directory configured. (apache/ratis#903)
      - Pluggable Ratis-Metrics (RATIS-1688)
      - RATIS-1689. Remove the use of the thirdparty Gauge. (apache/ratis#728)
      - RATIS-1692. Remove the use of the thirdparty Counter. (apache/ratis#732)
      - RATIS-1693. Remove the use of the thirdparty Timer. (apache/ratis#734)
      - RATIS-1703. Move MetricsReporting and JvmMetrics to impl. (apache/ratis#741)
      - RATIS-1704. Fix SuppressWarnings(“VisibilityModifier”) in RatisMetrics. (apache/ratis#742)
      - RATIS-1710. Refactor metrics api and implementation to separated modules. (apache/ratis#749)
      - RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api. (apache/ratis#751)
      - RATIS-1391. Update library dropwizard.metrics version to 4.x (apache/ratis#632)
      - RATIS-1601. Use the shaded dropwizard metrics and remove the dependency (apache/ratis#671)
      - Streaming Protocol Change
      - RATIS-1569. Move the asyncRpcApi.sendForward(..) call to the client side. (apache/ratis#635)
   - New Features
      - Leader Lease (RATIS-1864)
      - RATIS-1865. Add leader lease bound ratio configuration (apache/ratis#897)
      - RATIS-1866. Maintain leader lease after AppendEntries (apache/ratis#898)
      - RATIS-1894. Implement ReadOnly based on leader lease (apache/ratis#925)
      - RATIS-1882. Support read-after-write consistency (apache/ratis#913)
      - StateMachine API
      - RATIS-1874. Add notifyLeaderReady function in IStateMachine (apache/ratis#906)
      - RATIS-1897. Make TransactionContext available in DataApi.write(..). (apache/ratis#930)
      - New Configuration Properties
      - RATIS-1862. Add the parameter whether to take Snapshot when stopping to adapt to different services (apache/ratis#896)
      - RATIS-1930. Add a conf for enable/disable majority-add. (apache/ratis#961)
      - RATIS-1918. Introduces parameters that separately control the shutdown of RaftServerProxy by JVMPauseMonitor. (apache/ratis#950)
      - RATIS-1636. Support re-config ratis properties (apache/ratis#800)
      - RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf. (apache/ratis#901)
   - Improvements & Bug Fixes
      - Netty
         - RATIS-1898. Netty should use EpollEventLoopGroup by default (apache/ratis#931)
         - RATIS-1899. Use EpollEventLoopGroup for Netty Proxies (apache/ratis#932)
         - RATIS-1921. Shared worker group in WorkerGroupGetter should be closed. (apache/ratis#955)
         - RATIS-1923. Netty: atomic operations require side-effect-free functions. (apache/ratis#956)
      - RaftServer
         - RATIS-1924. Increase the default of raft.server.log.segment.size.max. (apache/ratis#957)
         - RATIS-1892. Unify the lifetime of the RaftServerProxy thread pool (apache/ratis#923)
         - RATIS-1889. NoSuchMethodError: RaftServerMetricsImpl.addNumPendingRequestsGauge apache/ratis#922 (apache/ratis#922)
         - RATIS-761. Handle writeStateMachineData failure in leader. (apache/ratis#927)
         - RATIS-1902. The snapshot index is set incorrectly in InstallSnapshotReplyProto. (apache/ratis#933)
         - RATIS-1912. Fix infinity election when perform membership change. (apache/ratis#954)
         - RATIS-1858. Follower keeps logging first election timeout. (apache/ratis#894)

- 3.0.1:This is a bugfix release. See the [changes between 3.0.0 and 3.0.1](apache/ratis@ratis-3.0.0...ratis-3.0.1) releases.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Cluster manual test.

Closes #2480 from SteNicholas/CELEBORN-1400.

Authored-by: SteNicholas <programgeek@163.com>
Signed-off-by: Shuang <lvshuang.xjs@alibaba-inc.com>
@szetszwo szetszwo deleted the RATIS-1704 branch May 26, 2025 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@codings-dan codings-dan codings-dan approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@szetszwo @codings-dan