sedai.monitoring_provider

def add_cloudwatch_monitoring( account_id: str, credentials: sedai.credentials.AWSCredentials = None, lb_dimensions: list = None, app_dimensions: list = None, instance_dimensions: list = None, use_account_credentials: bool = True):

Add CloudWatch monitoring to an account

Parameters
  • account_id: The Sedai account id
  • credentials: A valid AWS credentials object. Refer to :ref: credentials for more details
  • lb_dimensions: The list of load balancer dimensions. Default: ["load_balancer_name"]
  • app_dimensions: The list of application dimensions. Default: ["application_id"]
  • instance_dimensions: The list of instance dimensions. Default: ["instance_id"]
  • use_account_credentials: Boolean indicating whether to use account credentials. Default: True
Returns

Boolean indicating if the monitoring provider was created successfully. If mandatory fields are missing, then an exception is raised.

By default, account credentials are used for cloudwatch too. For custom credentials, set use_account_credentials to False and provide the valid credentials

def add_new_relic_monitoring( account_id: str, new_relic_account_id: str, api_server: str, credentials: sedai.credentials.NewrelicCredentials, name: Optional[str] = None, lb_dimensions: Optional[list] = None, app_dimensions: Optional[list] = None, instance_dimensions: Optional[list] = None, container_dimensions: Optional[list] = None, namespace_dimensions: Optional[list] = None, cluster_dimensions: Optional[list] = None, integration_type: Optional[str] = 'AGENTLESS'):

Add New Relic monitoring to an account

Parameters
  • account_id: The account id
  • new_relic_account_id: The new relic account id
  • api_server: The new relic api server
  • credentials: The New Relic monitoring credentials. Refer to :ref: credentials for more details
  • name: An optional name for the monitoring provider
  • lb_dimensions: The list of load balancer dimensions. Default: ["load_balancer_name", "entity.name"]
  • app_dimensions: The list of application dimensions. Default: ["application_id", "appName", "entity.name"]
  • instance_dimensions: The list of instance dimensions. Default: ["instance_id","k8s.podName","k8s.pod.name"]
  • container_dimensions: The list of container dimensions. Default: ["container", "k8s.container.name", "k8s.containerName"]
  • namespace_dimensions: The list of namespace dimensions. Default: ["k8s.namespaceName"]
  • cluster_dimensions: The list of cluster dimensions. Default: ["clusterName"]
  • integration_type: The integration type. Valid values are: AGENTLESS, AGENT_BASED. Default: AGENTLESS
Returns

Boolean indicating if the monitoring provider was created successfully. If mandatory fields are missing, then an exception is raised.

For the list of dimentsions, if the list is passed, then that list is used as is. If the list is not passed, the default list is used. If an empty list is passed, then no dimensions are used.

def add_GKE_monitoring( account_id: str, project_id: str, credentials: sedai.credentials.GKEMonitoringCredentials, name: str = None, lb_dimensions: list = None, app_dimensions: list = None, instance_dimensions: list = None, region_dimensions: list = None, container_dimensions: list = None, namespace_dimensions: list = None, cluster_dimensions: list = None, integration_type: str = 'AGENT_BASED'):

Add GKE monitoring to an account

Parameters
  • account_id: The account id
  • project_id: The project id
  • credentials: The GKE monitoring credentials. Refer to :ref: credentials for more details
  • name: An optional name for the monitoring provider
  • lb_dimensions: The list of load balancer dimensions. Default: ["destination_service_name"]
  • app_dimensions: The list of application dimensions. Default: ["application_id"]
  • instance_dimensions: The list of instance dimensions. Default: ["pod_name"]
  • region_dimensions: The list of region dimensions. Default: ["location"]
  • container_dimensions: The list of container dimensions. Default: ["container_name"]
  • namespace_dimensions: The list of namespace dimensions. Default: ["destination_service_namespace", "namespace_name"]
  • cluster_dimensions: The list of cluster dimensions. Default: ["cluster_name"]
  • integration_type: The integration type. Valid values are: AGENTLESS, AGENT_BASED. Default: AGENT_BASED
Returns

Boolean indicating if the monitoring provider was created successfully. If mandatory fields are missing, then an exception is raised.

For the list of dimentsions, if the list is passed, then that list is used as is. If the list is not passed, the default list is used. If an empty list is passed, then no dimensions are used.

def add_datadog_monitoring( account_id: str, credentials: sedai.credentials.DatadogCredentials, name: str = None, lb_dimensions: list = None, app_dimensions: list = None, instance_dimensions: list = None, region_dimensions: list = None, container_dimensions: list = None, namespace_dimensions: list = None, cluster_dimensions: list = None, az_dimensions: list = None, env_dimensions: list = None, instance_id_pattern: str = None, integration_type: str = 'AGENTLESS'):

Add Datadog monitoring to an account

Parameters
  • account_id: The account id
  • credentials: The Datadog credentials. Refer to :ref: credentials for more details
  • name: An optional name for the monitoring provider
  • lb_dimensions: The list of load balancer dimensions. Default: ["destination_service_name"]
  • app_dimensions: The list of application dimensions. Default: ["application_id"]
  • instance_dimensions: The list of instance dimensions. Default: ["pod_name"]
  • region_dimensions: The list of region dimensions. Default: ["location"]
  • container_dimensions: The list of container dimensions. Default: ["container_name"]
  • namespace_dimensions: The list of namespace dimensions. Default: ["destination_service_namespace", "namespace_name"]
  • cluster_dimensions: The list of cluster dimensions. Default: ["cluster_name"]
  • az_dimensions: The list of availability zone dimensions. Default: ["availability_zone"]
  • env_dimensions: The list of environment dimensions. Default: []
  • instance_id_pattern: The instance id pattern. Default: None
  • integration_type: The integration type. Valid values are: AGENTLESS, AGENT_BASED. Default: AGENTLESS
Returns

Boolean indicating if the monitoring provider was created successfully. If mandatory fields are missing, then an exception is raised.

def add_federated_prometheus_monitoring( account_id: str, credentials: sedai.credentials.FederatedPrometheusCredentials, endpoint: str, name: Optional[str] = None, lb_dimensions: Optional[list] = None, app_dimensions: Optional[list] = None, instance_dimensions: Optional[list] = None, region_dimensions: Optional[list] = None, container_dimensions: Optional[list] = None, namespace_dimensions: Optional[list] = None, cluster_dimensions: Optional[list] = None, az_dimensions: Optional[list] = None, env_dimensions: Optional[list] = None, instance_id_pattern: Optional[str] = None, integration_type: Optional[str] = 'AGENTLESS'):

Add Federated Prometheus monitoring to an account

Parameters
  • account_id: The account id
  • credentials: The Federated Prometheus credentials. Refer to :ref: credentials for more details
  • endpoint: The Federated Prometheus endpoint.
  • name: An optional name for the monitoring provider
  • lb_dimensions: The list of load balancer dimensions. Default: ["service"]
  • app_dimensions: The list of application dimensions. Default: ["application_id"]
  • instance_dimensions: The list of instance dimensions. Default: ["pod"]
  • region_dimensions: The list of region dimensions. Default: ["region"]
  • container_dimensions: The list of container dimensions. Default: ["container"]
  • namespace_dimensions: The list of namespace dimensions. Default: ["namespace"]
  • cluster_dimensions: The list of cluster dimensions. Default: []
  • az_dimensions: The list of availability zone dimensions. Default: ["availability_zone"]
  • env_dimensions: The list of environment dimensions. Default: []
  • instance_id_pattern: The instance id pattern. Default: None
  • integration_type: The integration type. Valid values are: AGENTLESS, AGENT_BASED. Default: AGENTLESS
Returns

Boolean indicating if the monitoring provider was created successfully. If mandatory fields are missing, then an exception is raised.