Ice 3.7 Slice API Reference
Metrics.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICE_API"]]
8 [["cpp:doxygen:include:Ice/Ice.h"]]
9 [["cpp:header-ext:h"]]
10 
11 [["ice-prefix"]]
12 
13 [["js:module:ice"]]
14 [["js:cjs-module"]]
15 
16 [["objc:dll-export:ICE_API"]]
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:Ice"]]
20 
21 #include <Ice/BuiltinSequences.ice>
22 
30 #ifndef __SLICE2JAVA_COMPAT__
31 [["java:package:com.zeroc"]]
32 #endif
33 
34 ["objc:prefix:ICEMX", "swift:module:Ice:MX"]
35 module IceMX
36 {
37 
43 dictionary<string, int> StringIntDict;
44 
51 class Metrics
52 {
58  string id;
59 
67  long total = 0;
68 
74  int current = 0;
75 
83  long totalLifetime = 0;
84 
90  int failures = 0;
91 }
92 
100 {
107  string id;
108 
115 }
116 
122 sequence<MetricsFailures> MetricsFailuresSeq;
123 
132 sequence<Metrics> MetricsMap;
133 
140 dictionary<string, MetricsMap> MetricsView;
141 
148 {
149 }
150 
159 ["format:sliced"]
160 interface MetricsAdmin
161 {
172 
183  void enableMetricsView(string name)
184  throws UnknownMetricsView;
185 
196  void disableMetricsView(string name)
197  throws UnknownMetricsView;
198 
218  MetricsView getMetricsView(string view, out long timestamp)
219  throws UnknownMetricsView;
220 
235  MetricsFailuresSeq getMapMetricsFailures(string view, string map)
236  throws UnknownMetricsView;
237 
254  MetricsFailures getMetricsFailures(string view, string map, string id)
255  throws UnknownMetricsView;
256 }
257 
264 class ThreadMetrics extends Metrics
265 {
272  int inUseForIO = 0;
273 
280  int inUseForUser = 0;
281 
290  int inUseForOther = 0;
291 }
292 
299 {
305  int userException = 0;
306 
313  long size = 0;
314 
321  long replySize = 0;
322 }
323 
334 {
341  long size = 0;
342 
349  long replySize = 0;
350 }
351 
359 {
360 }
361 
369 {
370 }
371 
379 {
385  int retry = 0;
386 
392  int userException = 0;
393 
402 
411 }
412 
420 {
426  long receivedBytes = 0;
427 
433  long sentBytes = 0;
434 }
435 
436 }
IceMX::UnknownMetricsView
Raised if a metrics view cannot be found.
Definition: Metrics.ice:148
IceMX::RemoteMetrics
Provides information on invocations that are specifically sent over Ice connections.
Definition: Metrics.ice:369
IceMX::CollocatedMetrics
Provides information on invocations that are collocated.
Definition: Metrics.ice:359
IceMX::MetricsAdmin::getMetricsFailures
MetricsFailures getMetricsFailures(string view, string map, string id)
Get the metrics failure associated for the given metrics.
BuiltinSequences.ice
IceMX::MetricsMap
sequence< Metrics > MetricsMap
A metrics map is a sequence of metrics.
Definition: Metrics.ice:132
IceMX::ConnectionMetrics
Provides information on the data sent and received over Ice connections.
Definition: Metrics.ice:420
IceMX::MetricsFailures
A structure to keep track of failures associated with a given metrics.
Definition: Metrics.ice:100
Ice::StringSeq
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:51
IceMX::StringIntDict
dictionary< string, int > StringIntDict
A dictionnary of strings to integers.
Definition: Metrics.ice:43
IceMX::InvocationMetrics::collocated
MetricsMap collocated
The collocated invocation metrics map.
Definition: Metrics.ice:410
IceMX
The Ice Management eXtension facility.
Definition: Metrics.ice:29
IceMX::MetricsView
dictionary< string, MetricsMap > MetricsView
A metrics view is a dictionary of metrics map.
Definition: Metrics.ice:140
IceMX::Metrics
The base class for metrics.
Definition: Metrics.ice:52
IceMX::MetricsAdmin::getMetricsView
MetricsView getMetricsView(string view, out long timestamp)
Get the metrics objects for the given metrics view.
IceMX::ThreadMetrics
Provides information on the number of threads currently in use and their activity.
Definition: Metrics.ice:265
IceMX::ChildInvocationMetrics
Provides information on child invocations.
Definition: Metrics.ice:334
IceMX::MetricsAdmin::enableMetricsView
void enableMetricsView(string name)
Enables a metrics view.
IceMX::InvocationMetrics::remotes
MetricsMap remotes
The remote invocation metrics map.
Definition: Metrics.ice:401
IceMX::Metrics::id
string id
The metrics identifier.
Definition: Metrics.ice:58
IceMX::InvocationMetrics
Provide measurements for proxy invocations.
Definition: Metrics.ice:379
IceMX::MetricsFailuresSeq
sequence< MetricsFailures > MetricsFailuresSeq
A sequence of MetricsFailures.
Definition: Metrics.ice:122
IceMX::MetricsFailures::failures
StringIntDict failures
The failures observed for this metrics.
Definition: Metrics.ice:114
IceMX::MetricsAdmin::getMetricsViewNames
Ice::StringSeq getMetricsViewNames(out Ice::StringSeq disabledViews)
Get the names of enabled and disabled metrics.
IceMX::MetricsAdmin::getMapMetricsFailures
MetricsFailuresSeq getMapMetricsFailures(string view, string map)
Get the metrics failures associated with the given view and map.
IceMX::MetricsFailures::id
string id
The identifier of the metrics object associated to the failures.
Definition: Metrics.ice:107
IceMX::MetricsAdmin::disableMetricsView
void disableMetricsView(string name)
Disable a metrics view.
IceMX::DispatchMetrics
Provides information on servant dispatch.
Definition: Metrics.ice:299
IceMX::MetricsAdmin
The metrics administrative facet interface.
Definition: Metrics.ice:161