blob: 9764fce5282536b375f9fd6748e220cee91998aa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/*
* Copyright 2017, OpenCensus Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opencensus.stats;
/**
* Class that holds the implementations for {@link ViewManager} and {@link StatsRecorder}.
*
* <p>All objects returned by methods on {@code StatsComponent} are cacheable.
*
* @since 0.8
*/
public abstract class StatsComponent {
/**
* Returns the default {@link ViewManager}.
*
* @since 0.8
*/
public abstract ViewManager getViewManager();
/**
* Returns the default {@link StatsRecorder}.
*
* @since 0.8
*/
public abstract StatsRecorder getStatsRecorder();
/**
* Returns the current {@code StatsCollectionState}.
*
* <p>When no implementation is available, {@code getState} always returns {@link
* StatsCollectionState#DISABLED}.
*
* <p>Once {@link #getState()} is called, subsequent calls to {@link
* #setState(StatsCollectionState)} will throw an {@code IllegalStateException}.
*
* @return the current {@code StatsCollectionState}.
* @since 0.8
*/
public abstract StatsCollectionState getState();
/**
* Sets the current {@code StatsCollectionState}.
*
* <p>When no implementation is available, {@code setState} does not change the state.
*
* <p>If state is set to {@link StatsCollectionState#DISABLED}, all stats that are previously
* recorded will be cleared.
*
* @param state the new {@code StatsCollectionState}.
* @throws IllegalStateException if {@link #getState()} was previously called.
* @deprecated This method is deprecated because other libraries could cache the result of {@link
* #getState()}, use a stale value, and behave incorrectly. It is only safe to call early in
* initialization. This method throws {@link IllegalStateException} after {@code getState()}
* has been called, in order to limit changes to the result of {@code getState()}.
* @since 0.8
*/
@Deprecated
public abstract void setState(StatsCollectionState state);
}
|
