Files
query-orchestration/docs
Michael McGuinness 0af049e96f Merged in feature/docGen (pull request #88)
Basic Generate

* basicgenerate

* basic
2025-03-05 13:50:43 +00:00
..

Query Orchestration

docCleanRunner

docInitRunner

docSyncRunner

docTextRunner

jobSyncRunner

metricsExample_test

This main.go serves as an example of how to use the custom Prometheus metrics package.

It demonstrates:

  1. Setting up metrics with proper context handling

  2. Configuring different types of metrics (Counter, Gauge, Histogram, Summary)

  3. Recording metrics safely in a concurrent environment

  4. Implementing graceful shutdown

  5. Proper error handling

queryRunner

queryService

This API currently manages all user entities to be managed. This allows users of the service to change required entities and processes.

The entities in question:

  • Client - A client is a single client of the Doczy project, all configurations and jobs for a client will be in reference to the respective client.

  • Job - A job is a single instance of requirements for a client. This maintains a set of queries and processes in relation to itself.

  • Collector - A collector specifies the required queries for export for a given job.

  • Sample - A sample is a subset of documents to be used for testing. When it is active a job will only process documents in the sample.

  • Query - A query is a block of processing of data which takes an input and produces an output.

  • Export - An export is a manually started process which outputs the results for a job to a given location.

querySyncRunner

queryVersionSyncRunner

Generated by Doczy