CLOUDP-294461: [Product Metrics/Observability] Implement Metric Collection workflow #357
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ran the code locally and noticed I had to run the script twice, the first time I got this error: With some debugging it seems like |
Comment on lines
7
to
12
| const config = { | ||
| defaultOasFilePath: path.join(rootDir, 'openapi', 'v2.json'), | ||
| defaultCollectorResultsFilePath: path.join(dirname, 'ipa-collector-results-combined.log'), | ||
| defaultRulesetFilePath: path.join(dirname, '..', 'ipa-spectral.yaml'), | ||
| defaultMetricCollectionResultsFilePath: path.join(dirname, 'metric-collection-results.json'), | ||
| }; |
There was a problem hiding this comment.
Can you give an example how we can set different configurations? For the GH action later on we'd like to point to the generated FOAS for example
There was a problem hiding this comment.
The script currently supports providing a custom OAS file only, which must be in JSON format.
For example, you can run the script using:
node metricCollection.js "<path_to_oas_file>" to specify a custom OAS file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Jira ticket: CLOUDP-294461
metricCollectionJobimplements the workflow for metric collection:metric-collection-results.jsonmetricCollectionJoballows custom OAS files, but the default is thev2.jsonExample:
node metricCollection.js <path-to-OAS-file>metricCollectionJobproduces a couple of output files:/outputs/metric-collection-results.json: The data collected for metrics/outputs/spectral-output.txt: Output of spectral command/outputs/spectral-report.xml: Report for the errorsipa-collector-results-combined.log: This file is intended to store the collector results. However, it does not appear to be populated whenmetricCollection.jsis executed, even thoughmetric-collection-results.json, which is constructed using this file, is populated correctly.Testing
Example output file:
metric-collection-results.json
Checklist
Changes to Spectral