Metrics.ice

Go to the documentation of this file.

// **********************************************************************
//
// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

#pragma once

[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]

#include <Ice/BuiltinSequences.ice>

["objc:prefix:ICEMX"]
module IceMX
{

dictionary<string, int> StringIntDict;

class Metrics
{
    string id;

    long total = 0;

    int current = 0;

    long totalLifetime = 0;

    int failures = 0;
};

struct MetricsFailures
{
    string id;

    StringIntDict failures;
};

sequence<MetricsFailures> MetricsFailuresSeq;

sequence<Metrics> MetricsMap;

dictionary<string, MetricsMap> MetricsView;

exception UnknownMetricsView
{
};

["format:sliced"]
interface MetricsAdmin
{
    Ice::StringSeq getMetricsViewNames(out Ice::StringSeq disabledViews);

    void enableMetricsView(string name)
        throws UnknownMetricsView;

    void disableMetricsView(string name)
        throws UnknownMetricsView;

    MetricsView getMetricsView(string view, out long timestamp)
        throws UnknownMetricsView;

    MetricsFailuresSeq getMapMetricsFailures(string view, string map)
        throws UnknownMetricsView;

    MetricsFailures getMetricsFailures(string view, string map, string id)
        throws UnknownMetricsView;
};

class ThreadMetrics extends Metrics
{
    int inUseForIO = 0;

    int inUseForUser = 0;

    int inUseForOther = 0;
};

class DispatchMetrics extends Metrics
{
    int userException = 0;

    long size = 0;

    long replySize = 0;
};

class ChildInvocationMetrics extends Metrics
{
    long size = 0;

    long replySize = 0;
};

class CollocatedMetrics extends ChildInvocationMetrics
{
};

class RemoteMetrics extends ChildInvocationMetrics
{
};

class InvocationMetrics extends Metrics
{
    int retry = 0;

    int userException = 0;

    MetricsMap remotes;

    MetricsMap collocated;
};

class ConnectionMetrics extends Metrics
{
    long receivedBytes = 0;

    long sentBytes = 0;
};

};