1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.apache.giraph.metrics;
20
21 /**
22 * Class holding metric names used in Giraph
23 */
24 // CHECKSTYLE: stop InterfaceIsTypeCheck
25 public interface MetricNames {
26 // CHECKSTYLE: resume InterfaceIsTypeCheck
27
28 //////////////////////////////////////////////////////////////////////////////
29 // Request counters per superstep
30 //////////////////////////////////////////////////////////////////////////////
31 /** Counter of requests handled locally */
32 String LOCAL_REQUESTS = "local-requests";
33 /** Counter of requets sent on the wire */
34 String REMOTE_REQUESTS = "remote-requests";
35 /** Guage of total requests */
36 String TOTAL_REQUESTS = "total-requests";
37 /** PercentGauge of requests that are handled locally */
38 String PERCENT_LOCAL_REQUESTS = "percent-local-requests";
39
40 /** Counter for sending vertices requests */
41 String SEND_VERTEX_REQUESTS = "send-vertex-requests";
42 /** Counter for sending a partition of messages for next superstep */
43 String SEND_WORKER_MESSAGES_REQUESTS = "send-worker-messages-requests";
44 /**
45 * Counter for sending a partition of messages for current superstep
46 * (used during partition exchange)
47 */
48 String SEND_PARTITION_CURRENT_MESSAGES_REQUESTS =
49 "send-partition-current-messages-requests";
50 /** Counter for sending a partition of mutations */
51 String SEND_PARTITION_MUTATIONS_REQUESTS =
52 "send-partition-mutations-requests";
53 /** Counter for sending aggregated values from one worker's vertices */
54 String SEND_WORKER_AGGREGATORS_REQUESTS = "send-worker-aggregators-requests";
55 /** Counter for sending aggregated values from worker owner to master */
56 String SEND_AGGREGATORS_TO_MASTER_REQUESTS =
57 "send-aggregators-to-master-requests";
58 /** Counter for sending aggregators from master to worker owners */
59 String SEND_AGGREGATORS_TO_OWNER_REQUESTS =
60 "send-aggregators-to-owner-requests";
61 /** Counter for sending aggregators from worker owner to other workers */
62 String SEND_AGGREGATORS_TO_WORKER_REQUESTS =
63 "send-aggregators-to-worker-requests";
64
65 /** Counter for time spent waiting on too many open requests */
66 String TIME_SPENT_WAITING_ON_TOO_MANY_OPEN_REQUESTS_MS =
67 "time-spent-waiting-on-too-many-open-requests-ms";
68 //////////////////////////////////////////////////////////////////////////////
69 // End of Request counters per superstep
70 //////////////////////////////////////////////////////////////////////////////
71
72 /** Counter of messages sent in superstep */
73 String MESSAGES_SENT = "messages-sent";
74
75 /** Counter of messages sent in superstep */
76 String MESSAGE_BYTES_SENT = "message-bytes-sent";
77
78 /** Histogram for vertices in mutations requests */
79 String VERTICES_IN_MUTATION_REQUEST = "vertices-per-mutations-request";
80
81 /** Number of bytes sent in superstep */
82 String SENT_BYTES = "sent-bytes";
83 /** Number of bytes received in superstep */
84 String RECEIVED_BYTES = "received-bytes";
85
86 /** PercentGauge of memory free */
87 String MEMORY_FREE_PERCENT = "memory-free-pct";
88
89 /** Total edges loaded */
90 String EDGES_FILTERED = "edges-filtered";
91 /** Percent of edges filtered out */
92 String EDGES_FILTERED_PCT = "edges-filtered-pct";
93
94 /** Total vertices filtered */
95 String VERTICES_FILTERED = "vertices-filtered";
96 /** Percent of vertices filtered out */
97 String VERTICES_FILTERED_PCT = "vertices-filtered-pct";
98
99 /** Name of metric for compute times per partition */
100 String HISTOGRAM_COMPUTE_PER_PARTITION = "compute-per-partition-ms";
101 }