Installation and setup (Mongo profiler)

Pre-requisites

1. Download the latest version of the MongoDB profiler from the Delphix download page.

2. Ensure that the host running the profiler has podman installed.

3. Set up the Hyperscale MongoDB Connector and add the required ConnectorInfo details.

Procedure

1. Untar the profiler downloaded from Delphix’s download page. It should contain the container images for the profiler and the podman-compose.yaml file to run the profiler.

   CODE

   tar xzvf mongo-profiler.tar.gz

2. Create db_connection_conf.yaml using the template and populate the desired information.

   CODE

   cp db_connection_conf.yaml.template db_connection_conf.yaml
   
   cat db_connection_conf.yaml
   #
   # Copyright (c) 2023, 2025 by Delphix. All rights reserved.
   #
   source_mongodb_uri: "__MONGODB_URI__"
   source_database: "__SOURCE_DATABASE_NAME__"
   source_collection: "__SOURCE_COLLECTION_NAME__"
   source_username: "__SOURCE_DATABASE_USER__"
   target_database: "__TARGET_DATABASE_NAME__"
   target_collection: "__TARGET_COLLECTION_NAME__"
   
   
   # optional size parameters
   # Note: Please mention any one of the below parameters (sample_size and sample_percentage).
   # If both parameters are specified, sample_size will take precedence.
   # Note: Omit the character '%' as a suffix when providing sample_percentage. Refer the example below.
   
   # Sample size is the number of documents to be sampled in a given collection.
   # Sample percentage is the percentage of total number of documents to be sampled in a given collection.
   
   # sample_size: <__INTEGER_REPRESENTING_SIZE_OF_DATA_TO_BE_SAMPLED__>

3. Check the help of profiler.sh.

   CODE

   ./profiler.sh
   Usage: ./profiler.sh [OPTIONS]
   
     Create masking inventory file.
   
   Options:
     -o OPERATION          Operations
                             masking-inventory   Generate masking inventory JSON file.
                             data-sets           Execute API /data-sets using the
                                                   generated masking inventory file.
   
     -c DB_CONN_CONF       Path of db_connection_conf.yaml
   
     [-u UNLOAD_SPLIT]     Refer Hyperscale docs for more details.
                           Required for "data-sets" operation only.
   
     [-e HSENGINE]         Hostname or IP of HyperScale Engine
     [-k KEY]              API Key for Controller
     [-d CONNECTOR-ID]     Connector ID
     [-help]               Show this message and exit.
   
   
     Examples,
   
     #./profiler.sh -o masking-inventory -c DB_CONN_CONF.yaml
   
     #./profiler.sh -o data-sets -c DB_CONN_CONF.yaml -e HSENGINE.com -k APIKEY -d ID -u UNLOAD_SPLIT