Parca

  • By Canonical Observability
Channel Revision Published Runs on
latest/stable 128 14 Sep 2023
Ubuntu 22.04 Ubuntu 20.04
latest/beta 137 29 Feb 2024
Ubuntu 22.04 Ubuntu 20.04
latest/edge 142 01 May 2024
Ubuntu 22.04 Ubuntu 20.04
juju deploy parca
Show information

Learn to deploy on juju >

Platform:

Ubuntu
22.04 20.04

charms.parca.v0.parca_config

Helpers for generating Parca configuration.

This library is used for generating YAML configuration files for Parca, the continuous profiling tool. More information about Parca can be found at https://www.parca.dev/.

You can use this library as follows:

from charms.parca.v0.parca_config import ParcaConfig, parca_command_line

# Generate a Parca config and get the dictionary representation
config = ParcaConfig().to_dict()

# Get the YAML representation of the config
yaml_config = str(ParcaConfig())

# Generate a command line to start Parca (pass the Parca charm config)
cmd = parca_command_line(app_config)

Index

def parca_command_line(app_config: dict)

Generate a valid Parca command line.

Arguments

app_config

Charm configuration dictionary.

bin_path

Path to the Parca binary to be started.

config_path

Path to the Parca YAML configuration file.

profile_path

Path to profile storage directory.

store_config

Configuration to send profiles to a remote store

def parse_version(vstr: str)

Description

Parse the output of 'parca --version' and return a representative string. None

class ParcaConfig

Description

Class representing the Parca config file. None

Methods

ParcaConfig. __init__( self , scrape_configs )

ParcaConfig. to_dict( self )

Description

Return the Parca config as a Python dictionary. None

ParcaConfig. __str__( self )

Description

Return the Parca config as a YAML string. None