Enum AgentMetadata 

#[non_exhaustive]
pub enum AgentMetadata {
    #[non_exhaustive]
    Ec2AgentMetadata {
        aws_account_id: String,
        aws_region_id: String,
        ec2_instance_id: String,
        ec2_instance_type: String,
    },
    #[non_exhaustive]
    FargateAgentMetadata {
        aws_account_id: String,
        aws_region_id: String,
        ecs_task_arn: String,
        ecs_cluster_arn: String,
        cpu_limit: Option<OrderedF64>,
        memory_limit: Option<u64>,
    },
    Other,
    NoMetadata,
}

Host Metadata, which describes a host that runs a profiling agent. The current set of supported agent metadata is AWS-specific. If you are not running on AWS, you can use AgentMetadata::NoMetadata.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Ec2AgentMetadata

Metadata for an EC2 instance running on AWS

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

aws_account_id: String

The AWS account id

aws_region_id: String

The AWS region id

ec2_instance_id: String

The EC2 instance id

ec2_instance_type: String

Available on crate feature __unstable-fargate-cpu-count only.

The EC2 instance type

#[non_exhaustive]

FargateAgentMetadata

Metadata for a Fargate task running on AWS.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

aws_account_id: String

The AWS account id

aws_region_id: String

The AWS region id

ecs_task_arn: String

The ECS task ARN

For example, arn:aws:ecs:us-east-1:123456789012:task/profiler-metadata-cluster/5261e761e0e2a3d92da3f02c8e5bab1f

See the ECS documentation for more details

ecs_cluster_arn: String

The ECS cluster ARN

For example, arn:aws:ecs:us-east-1:123456789012:cluster/profiler-metadata-cluster

See the ECS documentation for more details

cpu_limit: Option<OrderedF64>

Available on crate feature __unstable-fargate-cpu-count only.

The CPU limit for the Fargate cluster

For example, Some(0.25). This will be None if the CPU limit is not specified.

See the ECS documentation for more details

memory_limit: Option<u64>

Available on crate feature __unstable-fargate-cpu-count only.

The memory limit for the Fargate cluster (in megabytes)

For example, Some(2048). This will be None if the memory limit is not specified.

See the ECS documentation for more details

Other

👎Deprecated: Use AgentMetadata::NoMetadata

Metadata for a host that is neither an EC2 nor a Fargate

NoMetadata

A placeholder when a host has no metadata, or when a reporter does not use metadata.

Implementations

impl AgentMetadata

pub fn ec2_agent_metadata( aws_account_id: String, aws_region_id: String, ec2_instance_id: String, ) -> Ec2AgentMetadataBuilder

Create a builder for EC2 agent metadata

Normally, for real-world use, you would get the metadata using autodetection via aws::load_agent_metadata, aws::load_agent_metadata, this function is intended for use in tests.

Example

let metadata = AgentMetadata::ec2_agent_metadata(
    "123456789012".to_string(),
    "us-east-1".to_string(),
    "i-1234567890abcdef0".to_string(),
).build();

pub fn fargate_agent_metadata( aws_account_id: String, aws_region_id: String, ecs_task_arn: String, ecs_cluster_arn: String, ) -> FargateAgentMetadataBuilder

Create a builder for Fargate agent metadata

Normally, for real-world use, you would get the metadata using autodetection via aws::load_agent_metadata, aws::load_agent_metadata, this function is intended for use in tests.

Example

let metadata = AgentMetadata::fargate_agent_metadata(
    "123456789012".to_string(),
    "us-east-1".to_string(),
    "arn:aws:ecs:us-east-1:123456789012:task/cluster/5261e761e0e2a3d92da3f02c8e5bab1f".to_string(),
    "arn:aws:ecs:us-east-1:123456789012:cluster/profiler-metadata-cluster".to_string(),
)
.with_cpu_limit(0.25)
.with_memory_limit(2048)
.build();

Trait Implementations

impl Clone for AgentMetadata

fn clone(&self) -> AgentMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentMetadata

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

Formats the value using the given formatter.

impl PartialEq for AgentMetadata

fn eq(&self, other: &AgentMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AgentMetadata

impl StructuralPartialEq for AgentMetadata