Here you can find details about analytics implementation for cxOne.
The analytics project has several use cases that together requires a solution capable of storing, processing and exporting data to external or interna usage. All data will be stored in UTC and converted to other zones when queried.
Entities defined in this document, reflects the implementation of the new datastore for analytics. The purpose is to store date in a more performatic and kpi oriented structure. Entities will be implemented inside ast-analytics-datastore
Scan related entitiesProject related entitiesApplication related entitiesVulnerabilities related entitiesCxIam related entities
During the last few months, a new analytics solution is being designed in order to extract data from the CxOne product. This data comes from the different services of the product and consequently this data has different formats and information depending on the source of it.
The purpose of this document is to define the format that matches the needs of the BI teams that will use the data. To facilitate this documentation process, the information has been divided into Entities that directly relate to the information that can be found in the services (for example, Scans Entity contains information on the scans (from scan creation to scan status).
Please note that document is a work in progress and will be updated until an agreement between both teams has been reached.
each entity must have a audit field to control the data export. A flag (bit) with true or false to show if the line was exported or not
A notification should be sent if a exception is raised on the line processing.
Check all diagrams in draw.io
analytics-datastore:
address: "${ANALYTICS_DATASTORE_GRPC_ADDRESS:static://localhost:25836}"
core-scans:
address: ${SCANS_GRPC_ADDRESS:static://localhost:26501s}
core-projects:
address: "${PROJECTS_GRPC_ADDRESS:static://localhost:26502}"
core-applications:
address: "${APPLICATIONS_GRPC_ADDRESS:static://localhost:26503}"
core-summary:
address: "${CORE_SUMMARY_RESULTS_GRPC_ADDRESS:static://localhost:27502}"
core-metadata:
address: "${CORE_METADATA_RESULTS_GRPC_ADDRESS:static://localhost:26505}"
sca-results:
address: "${CORE_SCA_RESULTS_GRPC_ADDRESS:static://localhost:25504}"
kics-results:
address: "${CORE_KICS_RESULTS_GRPC_ADDRESS:static://localhost:24503}"
sast-results:
address: "${CORE_SAST_RESULTS_GRPC_ADDRESS:static://localhost:23500}"
core-featureflag:
address: "${FEATURE_FLAG_GRPC_ADDRESS:static://localhost:20500}"
sast-metadata:
address: "${SAST_METADATA_GRPC_ADDRESS:static://localhost:22500}"
kics-metadata:
address: "${KICS_METADATA_GRPC_ADDRESS:static://localhost:21500}"| Component Variable | Secret |
|---|---|
| ANALYTICS_READ_DB_HOST | analyticssql_read_host |
| ANALYTICS_READ_DB_PORT | analyticssql_read_port |
| ANALYTICS_READ_DB | analytics |
| ANALYTICS_READ_DB_USER | analyticssql_read_username |
| ANALYTICS_READ_DB_PASS | analyticssql_read_password |
| ANALYTICS_WRITE_DB_HOST | analyticssql_write_host |
| ANALYTICS_WRITE_DB_PORT | analyticssql_write_port |
| ANALYTICS_WRITE_DB | analytics |
| ANALYTICS_WRITE_DB_USER | analyticssql_write_username |
| ANALYTICS_WRITE_DB_PASS | analyticssql_write_password |
All rights reserved to Checkmarx.
Built by Nautilus Team
Team Lead: Igor Matos - igor.matos@checkmarx.com