Package io.opencensus.contrib.grpc.metrics

Class RpcViews

  • public final class RpcViews
extends java.lang.Object
    Helper class that allows users to register rpc views easily.
    Since:
    0.11

    • Field Detail

      • RPC_CUMULATIVE_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> RPC_CUMULATIVE_VIEWS_SET

      • GRPC_CLIENT_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> GRPC_CLIENT_VIEWS_SET

      • GRPC_SERVER_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> GRPC_SERVER_VIEWS_SET

      • RPC_INTERVAL_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> RPC_INTERVAL_VIEWS_SET

      • GRPC_REAL_TIME_METRICS_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> GRPC_REAL_TIME_METRICS_VIEWS_SET

      • GRPC_CLIENT_BASIC_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> GRPC_CLIENT_BASIC_VIEWS_SET

      • GRPC_CLIENT_RETRY_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> GRPC_CLIENT_RETRY_VIEWS_SET

      • GRPC_SERVER_BASIC_VIEWS_SET

        static final com.google.common.collect.ImmutableSet<View> GRPC_SERVER_BASIC_VIEWS_SET

    • Constructor Detail

      • RpcViews

        private RpcViews()

    • Method Detail

      • registerAllGrpcViews

        public static void registerAllGrpcViews()
        Registers all standard gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        This is equivalent with calling registerClientGrpcViews() and registerServerGrpcViews().

        Since:
        0.13

      • registerAllGrpcViews

        static void registerAllGrpcViews​(ViewManager viewManager)

      • registerClientGrpcViews

        public static void registerClientGrpcViews()
        Registers all standard client gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.16

      • registerClientGrpcViews

        static void registerClientGrpcViews​(ViewManager viewManager)

      • registerClientRetryGrpcViews

        public static void registerClientRetryGrpcViews()
        Registers client retry gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.31.0

      • registerClientRetryGrpcViews

        static void registerClientRetryGrpcViews​(ViewManager viewManager)

      • registerServerGrpcViews

        public static void registerServerGrpcViews()
        Registers all standard server gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.16

      • registerServerGrpcViews

        static void registerServerGrpcViews​(ViewManager viewManager)

      • registerAllGrpcBasicViews

        public static void registerAllGrpcBasicViews()
        Registers all basic gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        This is equivalent with calling registerClientGrpcBasicViews() and registerServerGrpcBasicViews().

        Since:
        0.19

      • registerAllGrpcBasicViews

        static void registerAllGrpcBasicViews​(ViewManager viewManager)

      • registerClientGrpcBasicViews

        public static void registerClientGrpcBasicViews()
        Registers basic client gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.19

      • registerClientGrpcBasicViews

        static void registerClientGrpcBasicViews​(ViewManager viewManager)

      • registerServerGrpcBasicViews

        public static void registerServerGrpcBasicViews()
        Registers basic server gRPC views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.19

      • registerServerGrpcBasicViews

        static void registerServerGrpcBasicViews​(ViewManager viewManager)

      • registerAllCumulativeViews

        @Deprecated
public static void registerAllCumulativeViews()
        Deprecated.
        in favor of registerAllGrpcViews(). It is likely that there won't be stats for the old views, but you may still want to register the old views before they are completely removed.
        Registers all standard cumulative views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.11.0

      • registerAllCumulativeViews

        static void registerAllCumulativeViews​(ViewManager viewManager)

      • registerAllIntervalViews

        @Deprecated
public static void registerAllIntervalViews()
        Deprecated.
        because interval window is deprecated. There won't be interval views in the future.
        Registers all standard interval views.

        It is recommended to call this method before doing any RPC call to avoid missing stats.

        Since:
        0.11.0

      • registerAllIntervalViews

        static void registerAllIntervalViews​(ViewManager viewManager)

      • registerAllViews

        static void registerAllViews​(ViewManager viewManager)

      • registerRealTimeMetricsViews

        public static void registerRealTimeMetricsViews()
        Registers views for real time metrics reporting for streaming RPCs. This views will produce data only for streaming gRPC calls.
        Since:
        0.18

      • registerRealTimeMetricsViews

        static void registerRealTimeMetricsViews​(ViewManager viewManager)