Guides
ChangelogStatus PageAPI ExplorerAPI ReferenceCLI ReferenceBlog

Deployments

About

Please review the Architecture Overview document for detailed information on selecting the appropriate deployment model. Monte Carlo connects to two types of integrations, and each is deployed on its own:

If you're unsure about which deployment type you're currently using or wish to use, please refer to the definitions or contact your account representative for assistance.

Definitions and Terminology

To help with clarity, we have defined the following terms and phrases:

  • Cloud Deployments: Refers to customers who connect to an integration without deploying any infrastructure. This term is synonymous with SaaS deployments.

  • Hybrid Deployments: Refers to customers who connect to an integration using an Agent or have a Data Store. For more details, please see the definition here.

  • Integrations: This term encompasses a variety of connections supported by the Monte Carlo Platform, independently of the developer toolkit.

Requirements

  • Monte Carlo Role and Subscription: You must have the Account Owner role in Monte Carlo. Additionally, your account must be subscribed to either the Scale or Enterprise tier with an ESP (Enterprise Support Plan) for a hybrid deployment. The Generic Agent requires an Enterprise plan with the Advanced Networking add-on.
  • Cloud Admin: For hybrid deployments, administrative access to AWS, Azure or GCP (or, for the Generic Agent, to the platform that hosts it) is necessary for the setup.
  • Additional Admin Roles: Depending on the specific integration, you may also need administrative rights. Additionally, please note that certain integrations require specific subscription tiers and configurations with the respective vendors for certain functionalities. Refer to your vendor's documentation for more details.

Data integrations

See Data Integrations for the setup steps of each deployment.

Cloud Deployments

Add the integrations you want to connect. See Cloud Deployments.

Hybrid Deployments

Deploy a data store, or a collection agent and data store, in your environment, then add your integrations. See Hybrid Deployments.

Agent integrations

Deploy the Agent Observability Data Platform and a collection agent in your cloud account. See Agent Integrations.

FAQs

How Do I Check Which Version of the Platform or Deployments I Am Using?

Looking for your collection agent's software version? See Agent Versions and Updates.

👍

If your account was created after April 24th, 2024, it will automatically be using the V2 platform or newer.

To check the status of your deployment, follow these steps using our API or Command Line Interface (CLI).

API

  1. Access the API Explorer:
    Visit the API Explorer in the Monte Carlo UI (learn more about the API Explorer here).

    Alternatively, you can generate an API key and use tools such as cURL or Postman to make API calls.

  2. Trigger the API:
    Use this API to fetch deployment details. For instance:

    query getPlatformServices {
  getPlatformServices {
    uuid
    deployment {
      deploymentType
    }
  }
}

CLI

  1. Install and Configure the CLI:
    If you haven't done so already, follow the installation and configuration instructions. Ensure you have at least version v0.100.0 of the CLI.
  2. Execute the Command:
    Open your terminal and run the following command (reference docs): 
    montecarlo platform list

Either way, you can use the following table to interpret the output and determine the status of your deployment:

TypePlatformDescription
CLOUD_V1V1Legacy cloud deployment
CLOUD_V2V2Cloud deployment using the new platform
REMOTE_V1V1Legacy hybrid deployment (data collector)
REMOTE_V1.5V1.5Hybrid deployment (remote agent or data store) not using the new platform
REMOTE_V2V2Hybrid deployment (remote agent or data store) using the new platform

Can I use more than one deployment (e.g., cloud, agent, etc.)?

Yes, please ask Bayes or contact your account representative to learn more.

What types of integrations do I usually need to set up connectivity for?

Generally, you might need to enable connectivity between the Monte Carlo Platform and your integration (Cloud) or between the Monte Carlo Agent and your integration (Hybrid). This varies by vendor and depends on how you are managing your resource (e.g., whether it is publicly available).

For push-based developer tools or integrations that are automatically generated by query logs, usually, no action is required. This includes, but is not limited to, integrations like:

  • Atlan
  • Airflow
  • dbt Core
  • Sigma
  • Mode

These integrations also might not use the collection platform, agents, and data stores.

For more information on connectivity, please refer to our Network Connectivity documentation.

How do I list which integrations are using a deployment if I have more than one?

If you have more than one deployment and/or want to see which connections are using a specific deployment, you can do so in the Monte Carlo UI: open the deployment on the Deployments page (Settings → Deployments). Its Integrations section lists the integrations that use it.

You can also do so via the API:

  1. Access the API Explorer:
    Visit the API Explorer in the Monte Carlo UI (learn more about the API Explorer here).

    Alternatively, you can generate an API key and use tools such as cURL or Postman to make API calls.

  2. Trigger the API:
    Use the getPlatformServices API to fetch deployment details. For instance:

    query getPlatformServices {
  getPlatformServices {
    uuid
    deployment {
      deploymentType
      platform {
        ipAddresses
      }
    }
    connections {
      uuid
      name
      connectionType
    }
  }
}
    query getPlatformServices {
  getPlatformServices(connectionTypes: ["snowflake"]) {
    uuid
    deployment {
      deploymentType
      platform {
        ipAddresses
      }
    }
  }
}
    query getPlatformServices {
  getPlatformServices(serviceUuid: "d8214cdf-00d2-4848-a8e3-947f0f6f7613") {
    uuid
    deployment {
      deploymentType
      platform {
        ipAddresses
      }
    }
    connections {
      uuid
      name
      connectionType
    }
  }
}

How do I list all of my Data Stores or Collection Agents?

All registered data stores and collection agents are listed on the Deployments page in the Monte Carlo UI (Settings → Deployments). Open one to see its details, including the agent UUID.

They can also be retrieved via the API or Command Line Interface (CLI). See below:

API

  1. Access the API Explorer:
    Visit the API Explorer in the Monte Carlo UI (learn more about the API Explorer here).

    Alternatively, you can generate an API key and use tools such as cURL or Postman to make API calls.

  2. Trigger the API:
    Use the getPlatformServices API to fetch deployment details. For instance:

    query getPlatformServices {
  getPlatformServices {
    uuid
    deployment {
      deploymentType
      agent {
        uuid
        endpoint
        agentType
      }
    }
  }
}

CLI

  1. Install and Configure the CLI:
    If you haven't done so already, follow the installation and configuration instructions.
  2. Execute the Command:
    Open your terminal and run the following command (reference docs): 
    montecarlo agents list

How do I remove a Data Store or Collection Agent?

A data store or collection agent can be deregistered with the Command Line Interface (CLI). See details below:

  1. Install and Configure the CLI:
    If you haven't done so already, follow the installation and configuration instructions.
  2. Execute the Command:
    Open your terminal and run the following command (reference docs): 
    montecarlo agents deregister --agent-id <agent_id>
    If you have more than one agent, you can refer here for details on how to fetch the agent ID (UUID).

Note that deregistering either a data store or agent does not remove any resources you may have provisioned, and replacing either will mean previous data (history) will no longer be accessible unless migrated.

Importantly, jobs also might fail if you remove an agent or store without coordinating with our team. Please reach out to your Monte Carlo representative or ask Bayes, and we'd be happy to help!

Updated 1 day ago

What’s Next

Did this page help you?