SQLPlus Query Metrics - PARR Tools

Overview

This project was developed to provide an automated method to capture performance metrics for a suite of Oracle queries using a docker container to execute them with SQL*Plus. This project provides a method to capture query metrics in a variety of configurations for flexibility and allows a user to define multiple queries and define the SQL*Plus connection string to determine which Oracle database instance to execute the queries on. This project is forked from the SQLPlus Query Metrics project.

Resources

• SQLPlus Query Metrics - PARR Tools Version Control Information:
  • URL: git@github.com:noaa-pifsc/PIFSC-Tools-SQLPlus-Query-Metrics-PARR-Tools.git
  • Version: 1.1 (Git tag: parr_tools_sqlplus_query_metrics_v1.1)
  • Forked repository (upstream)
    • SQLPlus Query Metrics README
    • SQLPlus Query Metrics Version Control Information:
      • URL: git@github.com:noaa-pifsc/PIFSC-Tools-SqlPlus-Query-Metrics.git
      • Version: 1.2 (Git tag: sqlplus_query_metrics_v1.2)

Scenarios

• There are three different scenarios implemented by the docker project:
  • Local - this scenario deploys the docker container to a local docker host and connects to a local Oracle database
  • Remote - this scenario deploys the docker container to a remote docker host and connects to a remote Oracle database
  • Hybrid - this scenario deploys the docker container to a local docker host and connects to a remote Oracle database

Setup Procedure

• Execute the appropriate docker preparation script stored in the deployment_scripts folder to prepare the docker container for deployment in a new working directory
  • For example use the prepare_docker_project.local.sh bash script to prepare the Local docker container for deployment in the c:/docker/sqlplus-query-metrics-parr-tools-local folder
• Update the DB_credentials.sql file in the appropriate new working directory to specify the Oracle SQL*Plus database connection string (e.g. c:/docker/sqlplus-query-metrics-parr-tools-local/docker/src/SQL/credentials/DB_credentials.sql) for the local scenario
• *Note: more information about the setup procedure for this forked project is available in the SQLPlus Query Metrics README

Building/Running Container

• Execute the appropriate build and deploy script for the given scenario (e.g. build_deploy_project.remote.sh for the remote scenario)

Docker Application Processing

• *Note: more information about the docker application processing for this forked project is available in the SQLPlus Query Metrics README

Checking Results

• Open the docker volume sqlplus-query-metrics-parr-tools-logs to view the log files for the different executions of the docker container
• Open the docker volume sqlplus-query-metrics-parr-tools-data to view the exported data files for the different queries
  • Open the parr-tools-query-metrics.csv to view the metrics that were captured for each query execution

License

See the LICENSE.md for details

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.