Struct ackorelic::NewRelicConfig

#[must_use]
pub struct NewRelicConfig<'a> { /* fields omitted */ }

Custom configuration used to connect to the New Relic daemon.

This only needs to be used if the New Relic daemon is running at a non-default location, or a different timeout is desired

Example:

use std::time::Duration;

use newrelic::{NewRelicConfig, LogOutput, LogLevel};

NewRelicConfig::default()
    .socket("/tmp/newrelic-alternative.sock")
    .timeout(Duration::from_millis(10000))
    .init()
    .expect("Could not connect to daemon!");

Methods

impl<'a> NewRelicConfig<'a>

pub fn socket(self, socket: &'a str) -> Self

Set the socket address used to connect to the New Relic daemon.

Generally, this function only needs to be called explicitly if the daemon socket location needs to be customised. By default, "/tmp/.newrelic.sock" is used, which matches the default socket location used by newrelic-daemon if one isn't given.

On Linux, if this starts with a literal '@', then this is treated as the name of an abstract domain socket instead of a filesystem path.

Examples:

use newrelic::NewRelicConfig;

NewRelicConfig::default()
    .socket("/tmp/.newrelic-alternative.sock")
    .init();

pub fn timeout(self, timeout: Duration) -> Self

Set the amount of time that the SDK will wait for a response from the daemon before considering initialization to have failed. If this is 0 or unset then the SDK's default value will be used.

Example:

use std::time::Duration;

use newrelic::NewRelicConfig;

NewRelicConfig::default()
    .timeout(Duration::from_millis(10000))
    .init();

pub fn logging(self, level: Level, output: LogOutput<'a>) -> Self

Configure logging for the New Relic SDK.

Defaults to LogLevel::Info and LogOutput::StdErr.

Note that this differs to the logs of the New Relic daemon, which are output by the daemon itself.

Examples:

Logging to stderr:

use newrelic::{NewRelicConfig, LogLevel, LogOutput};

NewRelicConfig::default()
    .logging(LogLevel::Debug, LogOutput::StdErr)
    .init();

Logging to a file:

use std::path::Path;

use newrelic::{NewRelicConfig, LogLevel, LogOutput};

NewRelicConfig::default()
    .logging(LogLevel::Debug, LogOutput::File(Path::new("test.txt")))
    .init();

pub fn init(self) -> Result<()>

Initialise the New Relic SDK.

If non-default settings are to be used, this must be called before the first App is created.

Example:

use std::path::Path;
use newrelic::{NewRelicConfig, LogLevel, LogOutput};

NewRelicConfig::default()
    .logging(LogLevel::Info, LogOutput::File(Path::new("test.txt")))
    .init();

Trait Implementations

impl<'a> Default for NewRelicConfig<'a>

fn default() -> Self

Returns the "default value" for a type.