Automate generating compatibility table for different logstash version

[sweep-ai]

Description

This PR automates the process of generating a compatibility table for different versions of Logstash. It includes the following changes:

• Modified the docker-compose.yml file to include multiple services, each running a different version of Logstash. This allows for testing the compatibility of metrics with different Logstash versions simultaneously.
• Added a new Go script, scripts/generate_compatibility_table.go, that iterates over the different Logstash versions in the development environment, checks the compatibility of metrics, and generates a markdown file with the compatibility table.
• Created a new markdown file, COMPATIBILITY.md, which is generated by the script and contains the compatibility table for the metrics across different versions of Logstash.
• Updated the Makefile to include a new command that runs the script for generating the compatibility table.

Summary of Changes

• Modified docker-compose.yml to include multiple Logstash versions for testing.
• Added scripts/generate_compatibility_table.go to automate the process of generating the compatibility table.
• Created COMPATIBILITY.md to store the generated compatibility table.
• Updated Makefile to include a new command for running the compatibility table generation script.

Fixes #158.

---

To checkout this PR branch, run the following command in your terminal:

git checkout sweep/automate-compatibility-table

To get Sweep to edit this pull request, leave a comment below or in the code. Leaving a comment in the code will only modify the file but commenting below can change the entire PR.

[kuskoman]

sweep: instead of modifying existing docker-compose i would like you to create a separate one, prefereably with other default ports and with other variables responsible for setting up custom ports. it would be nice if i could either generate a custom docker-compose for this matter, or dynamically specify logstash versions to test on demand.

[kuskoman]

actually i dont need logstash ports in docker-compose-compatibility
also, the generate_compatibility_table.go would be better if written simply in bash language
also, i think that the docker-compose-compatibility file is not finished

[sweep-ai]

GitHub actions yielded the following error.

The command that failed is make wait-for-compose. Here are the relevant lines from the logs:

fatal: ref HEAD is not a symbolic ref
docker-compose up -d --wait

Please note that the error message "fatal: ref HEAD is not a symbolic ref" is not related to the docker-compose command. It appears to be an error from a previous command or step in the workflow.

This is likely a linting or type-checking issue with the source code. Update the code the changes and avoid modifying the existing tests.

[kuskoman]

This part:

	metric1Available=$(jq -r '.Metric1' <<< "$metrics")
	metric2Available=$(jq -r '.Metric2' <<< "$metrics")
	metric3Available=$(jq -r '.Metric3' <<< "$metrics")

seems wrong

metrics could be fetched dynamically, you can see the file add_metrics_to_readme.sh as a reference

[kuskoman]

I did not want you to modify my wait-for-compose command, feel free to create another one, but leave this one as-is

[kuskoman]

you forgot to rename generate_compatibility_table.go to generate_compatibility_table.sh
make sure to make it executable file

[sweep-ai]

GitHub actions yielded the following error.

The command that failed is make wait-for-compose. Here are the relevant lines from the logs:

fatal: ref HEAD is not a symbolic ref
docker-compose up -d

Please note that the logs provided are truncated and may not include all the relevant information.

This is likely a linting or type-checking issue with the source code. Update the code the changes and avoid modifying the existing tests.

[sweep-ai]

GitHub actions yielded the following error.

The command that failed is make wait-for-compose. Here are the relevant lines from the logs:

fatal: ref HEAD is not a symbolic ref
cd /path/to/docker-compose/file && docker-compose up -d --wait
/bin/sh: 1: cd: can't cd to /path/to/docker-compose/file
make: *** [Makefile:68: wait-for-compose] Error 2

The command that failed is golangci-lint run. Here are the relevant lines from the logs:

scripts/generate_compatibility_table.go:1:1: illegal character U+0023 '#' (typecheck)
#!/bin/bash
^

The command that failed is go test ./... -covermode=atomic -coverprofile=coverage.out. Here are the relevant lines from the logs:

scripts/generate_compatibility_table.go:1:1: illegal character U+0023 '#'

There are a lot of errors. This is likely due to a small parsing issue or a missing import with the files changed in the PR.

This is likely a linting or type-checking issue with the source code. Update the code the changes and avoid modifying the existing tests.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (2da085b) 100.00% compared to head (08acf91) 100.00%.

❗ Current head 08acf91 differs from pull request most recent head 67c0091. Consider uploading reports for the commit 67c0091 to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #160   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines          589       589           
=========================================
  Hits           589       589           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kuskoman]

This part

for service in $(docker service ls --format "{{.Name}}"); do

is just wrong, you cannot use docker service ls, you have to fetch services from docker-compose-compatibility.yml

also

compatibilityTable="| Logstash Version | Metric 1 | Metric 2 | Metric 3 |\n|------------------|----------|----------|----------|\n"

metrics should be fetched dynamically

[kuskoman]

I would like you to rollback Makefile to the original one. Lets now focus on docker-compose-compatibility and generate_compatibility_table files. Lets not affect existing ones

[kuskoman]

Closing it for now, I will create the same thing fasterr