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

use crate::logs::LogFormat;
use std::time::Duration;

//
// LOGGING
//

/// Log format for files. See LogFormat for other values
pub(crate) const DEFAULT_LOG_FORMAT: LogFormat = LogFormat::Default;

/// Maximum size in Mb for a log file
pub(crate) const DEFAULT_LOG_MAX_SIZE_MB: u64 = 100;

/// Maximum number of files to create for a given node
pub(crate) const DEFAULT_LOG_MAX_FILES: u64 = 60;

/// Default endpoint for the OpenTelemetry collector
pub(crate) const DEFAULT_OPENTELEMETRY_ENDPOINT: &str =
    "https://otelcoll.orchestrator.ockam.io:443";

//
// TRACING
//

/// Timeout for trying to access the Telemetry collector endpoint when running a command
/// It is quite high but experimentation shows that sometimes there's quite some lag even if the endpoint is available
pub(crate) const DEFAULT_TELEMETRY_ENDPOINT_FOREGROUND_CONNECTION_TIMEOUT: Duration =
    Duration::from_millis(500);

/// Timeout for trying to access the Telemetry collector endpoint for a background
/// Since the node is going to run uninterrupted, we leave a longer amount of time than for a command
/// to try to reach the endpoint
pub(crate) const DEFAULT_TELEMETRY_ENDPOINT_BACKGROUND_CONNECTION_TIMEOUT: Duration =
    Duration::from_secs(2);

/// Timeout for exporting spans or log records
pub(crate) const DEFAULT_EXPORT_TIMEOUT: Duration = Duration::from_secs(5);

// Maximum time between the export of batches. We set it high for a foreground task
// because we want the spans to be exported at the end of the execution
pub(crate) const DEFAULT_FOREGROUND_EXPORT_SCHEDULED_DELAY: Duration = Duration::from_secs(10);

// Maximum time between the export of batches
pub(crate) const DEFAULT_BACKGROUND_EXPORT_SCHEDULED_DELAY: Duration = Duration::from_secs(1);

// Size of the queue used to batch spans.
pub(crate) const DEFAULT_SPAN_EXPORT_QUEUE_SIZE: u16 = 32768;

// Size of the queue used to batch logs.
pub(crate) const DEFAULT_LOG_EXPORT_QUEUE_SIZE: u16 = 32768;

// Maximum time for sending log record batches when using a foreground node
pub(crate) const DEFAULT_FOREGROUND_LOG_EXPORT_CUTOFF: Duration = Duration::from_millis(3000);

// Maximum time for sending span batches when using a foreground node
pub(crate) const DEFAULT_FOREGROUND_SPAN_EXPORT_CUTOFF: Duration = Duration::from_millis(3000);

// Maximum time for sending log record batches when using a background node
pub(crate) const DEFAULT_BACKGROUND_LOG_EXPORT_CUTOFF: Duration = Duration::from_millis(3000);

// Maximum time for sending span batches when using a background node
pub(crate) const DEFAULT_BACKGROUND_SPAN_EXPORT_CUTOFF: Duration = Duration::from_millis(3000);