ockam_api 0.93.0

Ockam's request-response API
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//
// LOGGING CONFIGURATION
//

/// Decides if logs should be created. Accepted values, see FromString<bool>. For example; true, false, 1, 0
pub(crate) const OCKAM_LOGGING: &str = "OCKAM_LOGGING";

/// Required log level. Accepted values, see LevelVar. For example: trace, debug, info, warn, error
pub(crate) const OCKAM_LOG_LEVEL: &str = "OCKAM_LOG_LEVEL";

//
//LOG FILE CONFIGURATION
//

/// Max size of a log file before it is rotated, in Mb
pub(crate) const OCKAM_LOG_MAX_SIZE_MB: &str = "OCKAM_LOG_MAX_SIZE_MB";

/// Maximum number of log files created per node
pub(crate) const OCKAM_LOG_MAX_FILES: &str = "OCKAM_LOG_MAX_FILES";

/// Log format. Accepted values, see LogFormat. For example: pretty, json, default
pub(crate) const OCKAM_LOG_FORMAT: &str = "OCKAM_LOG_FORMAT";

/// Filter for log messages based on crate names. Accepted values: 'all' or 'comma-separated strings'. For example: ockam_core,ockam_api
pub(crate) const OCKAM_LOG_CRATES_FILTER: &str = "OCKAM_LOG_CRATES_FILTER";

//
// TRACING CONFIGURATION
//

/// Decides if spans and log records should be created and exported. Accepted values, see BooleanVar. For example; true, false, 1, 0
pub(crate) const OCKAM_TELEMETRY_EXPORT: &str = "OCKAM_TELEMETRY_EXPORT";

/// Deprecated, use OCKAM_TELEMETRY_EXPORT instead
pub(crate) const OCKAM_OPENTELEMETRY_EXPORT: &str = "OCKAM_OPENTELEMETRY_EXPORT";

/// Decides if spans and log records should be exported via a secure channel to the project node. Accepted values, see BooleanVar. For example; true, false, 1, 0
pub(crate) const OCKAM_TELEMETRY_EXPORT_VIA_PROJECT: &str = "OCKAM_TELEMETRY_EXPORT_VIA_PROJECT";

/// Decides if spans and log records should be exported via a secure channel to the authority node. Accepted values, see BooleanVar. For example; true, false, 1, 0
pub(crate) const OCKAM_TELEMETRY_EXPORT_VIA_AUTHORITY: &str =
    "OCKAM_TELEMETRY_EXPORT_VIA_AUTHORITY";

/// Route to a node accepting telemetry data, over a secure channel. Accepted values, see MultiAddr. For example: /dnsaddr/localhost/tcp/30002/service/a4da84b7-af6f-4ba6-bf58-709f2b5f0153/service/api
pub(crate) const OCKAM_TELEMETRY_EXPORT_NODE_ROUTE: &str = "OCKAM_TELEMETRY_EXPORT_NODE_ROUTE";

/// Identifier of a node accepting telemetry data, over a secure channel. Accepted values, see Identifier. For example: Ief435842446fe86b7880c08d4187073711ec810136880d61cd04a9aa08e74eef
pub(crate) const OCKAM_TELEMETRY_EXPORT_NODE_IDENTIFIER: &str =
    "OCKAM_TELEMETRY_EXPORT_NODE_IDENTIFIER";

/// Name of the service forwarding telemetry data on a node accepting telemetry data, over a secure channel. For example: grpc_forwarder
pub(crate) const OCKAM_TELEMETRY_EXPORT_NODE_FORWARDER_SERVICE: &str =
    "OCKAM_TELEMETRY_EXPORT_NODE_FORWARDER_SERVICE";

/// Boolean set to true if the current user is an Ockam developer
pub const OCKAM_DEVELOPER: &str = "OCKAM_DEVELOPER";

/// If this variable is true, print statements will debug the setting of the OpenTelemetry export
pub(crate) const OCKAM_OPENTELEMETRY_EXPORT_DEBUG: &str = "OCKAM_OPENTELEMETRY_EXPORT_DEBUG";

//
// TELEMETRY COLLECTOR ENDPOINT CONFIGURATION
//

/// URL for the OpenTelemetry collector. Accepted values, see UrlVar. For example: http://127.0.0.1:4317
pub(crate) const OCKAM_OPENTELEMETRY_ENDPOINT: &str = "OCKAM_OPENTELEMETRY_ENDPOINT";

/// Timeout for trying to connect to the endpoint before deciding that exporting traces
/// from a foreground command will not be possible. For example: 500ms
pub(crate) const OCKAM_FOREGROUND_TELEMETRY_ENDPOINT_CONNECTION_TIMEOUT: &str =
    "OCKAM_FOREGROUND_TELEMETRY_ENDPOINT_CONNECTION_TIMEOUT";

/// Timeout for trying to connect to the endpoint before deciding that exporting traces
/// from a background node will not be possible. Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_BACKGROUND_TELEMETRY_ENDPOINT_CONNECTION_TIMEOUT: &str =
    "OCKAM_BACKGROUND_TELEMETRY_ENDPOINT_CONNECTION_TIMEOUT";

//
// TELEMETRY COLLECTOR EXPORT CONFIGURATION
//

/// Timeout for trying to export spans to the endpoint.
/// Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_SPAN_EXPORT_TIMEOUT: &str = "OCKAM_SPAN_EXPORT_TIMEOUT";

/// Timeout for trying to export log records to the endpoint.
/// Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_LOG_EXPORT_TIMEOUT: &str = "OCKAM_LOG_EXPORT_TIMEOUT";

/// Timeout for exporting the current batch of spans to the endpoint, when running a command.
/// Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_FOREGROUND_SPAN_EXPORT_SCHEDULED_DELAY: &str =
    "OCKAM_FOREGROUND_SPAN_EXPORT_SCHEDULED_DELAY";

/// Timeout for exporting the current batch of spans to the endpoint, when running a background node.
/// Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_BACKGROUND_SPAN_EXPORT_SCHEDULED_DELAY: &str =
    "OCKAM_BACKGROUND_SPAN_EXPORT_SCHEDULED_DELAY";

/// Timeout for exporting the current batch of log records to the endpoint, when running a command.
/// Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_FOREGROUND_LOG_EXPORT_SCHEDULED_DELAY: &str =
    "OCKAM_FOREGROUND_LOG_EXPORT_SCHEDULED_DELAY";

/// Timeout for exporting the current batch of log records to the endpoint, when running a background node.
/// Accepted values, see DurationVar. For example: 500ms
pub(crate) const OCKAM_BACKGROUND_LOG_EXPORT_SCHEDULED_DELAY: &str =
    "OCKAM_BACKGROUND_LOG_EXPORT_SCHEDULED_DELAY";

/// Size of the queue used to batch spans.
/// Accepted values, u16. For example: 2048
pub(crate) const OCKAM_SPAN_EXPORT_QUEUE_SIZE: &str = "OCKAM_SPAN_EXPORT_QUEUE_SIZE";

/// Size of the queue used to batch log records.
/// Accepted values, u16. For example: 2048
pub(crate) const OCKAM_LOG_EXPORT_QUEUE_SIZE: &str = "OCKAM_LOG_EXPORT_QUEUE_SIZE";

/// Maximum time for sending a log batch and not waiting for a response when running
/// a foreground command export log records. For example: 200ms
pub(crate) const OCKAM_FOREGROUND_LOG_EXPORT_CUTOFF: &str = "OCKAM_FOREGROUND_LOG_EXPORT_CUTOFF";

/// Maximum time for sending a span batch and not waiting for a response when running
/// a foreground command to export span batches. For example: 200ms
pub(crate) const OCKAM_FOREGROUND_SPAN_EXPORT_CUTOFF: &str = "OCKAM_FOREGROUND_SPAN_EXPORT_CUTOFF";

/// Maximum time for sending a log batch and not waiting for a response when running
/// a background command to export log records. For example: 200ms
pub(crate) const OCKAM_BACKGROUND_LOG_EXPORT_CUTOFF: &str = "OCKAM_BACKGROUND_LOG_EXPORT_CUTOFF";

/// Maximum time for sending a span batch and not waiting for a response when running
/// a background command to export span batches. For example: 200ms
pub(crate) const OCKAM_BACKGROUND_SPAN_EXPORT_CUTOFF: &str = "OCKAM_BACKGROUND_SPAN_EXPORT_CUTOFF";