Struct Builder

pub struct Builder { /* private fields */ }

Builder for the Logger

Implementations

impl Builder

pub fn new(log_name: &str, resource_type: &str) -> Self

Creates a Builder object.

Parameters

• log_name: The logName string to be used in the LogEntry
• resource_type: The required type field set in the resource MonitoredResource object of the LogEntry. For example: k8s_container.

Example

use slog_google::logger::Builder;
let (drain, _) = Builder::new(
    "projects/my-gcp-project/logs/my-log-id",
    "k8s_container",
)
.build();

pub fn with_resource_labels(self, labels: Value) -> Result<Self, Box<dyn Error>>

Sets resource labels to be applied.

These labels will populate the labels field in the resource MonitoredResource object of the LogEntry.

Example

use serde_json::json;
let resource_labels = json!(
{
    "pod_name": "dummy-value",
    "location": "europe-west1-b",
    "pod_name": std::env::var("HOSTNAME").unwrap_or_default(),
    "container_name": "my-app",
    "project_id": "my-gcp-project",
    "cluster_name": "my-gke-cluster",
    "namespace_name": "my-gke-namespace"
});

use slog_google::logger::Builder;
let (drain, _) = Builder::new(
    "projects/my-gcp-project/logs/my-log-id",
    "k8s_container",
)
.with_resource_labels(resource_labels)
.unwrap()
.build();

Errors

Will return Err if labels does not parse as JSON.

pub fn with_default_labels(self, labels: Value) -> Result<Self, Error>

Sets default labels to be applied in the labels field.

These will populate the labels top level field of the LogEntry. These labels are added in addition to any labels set in the logger statement.

Example

use serde_json::json;
let default_labels = json!(
{
    "application": "my-application",
    "team": "my-team",
    "version": "my-app-version",
    "role": "my-app-role",
    "environment": "production",
    "platform": "gcp",
});

Errors

Will return Err if labels does not parse as JSON.

pub fn with_log_level_label(self, log_level_label: &str) -> Self

Sets the label name to store the log level

If set, the log level value is added under this label the labels top level field of the LogEntry

If not set, the log level is not propagated, but you will still have the severity, which is always there.

pub fn build(self) -> (Logger, Receiver<WriteLogEntriesRequest>)

This returns a tuple with a Logger, which can be passed to the slog root logger as usual, and a std::sync::mpsc::Receiver channel. The Logger sends the WriteLogEntries it creates to this channel.

For instance you could output these to the console, if you have an external agent that reads the process’ output and ships it to Google Logging.

Trait Implementations

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.