diff --git a/README.md b/README.md index 6ce2196..633d266 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ +# How to get this going quickly... + +1. Add the query to queries.yml +2. Add an associated local sova query to sova-pattens.yml +3. Add a blob of text from the error you would like to test against to errors.txt + +Note: the softlinks +errors.txt ---> samples/errors-testing.err +queries.yml ---> src/data/queries.yml +sova-patterns.yml ---> src/data/sova-patterns.yml + +4. Execute tox +5. Submit patch +6. GREAT SUCCESS! + + # queries Hosts reusable log queries which are built into a single queries.json file. diff --git a/errors.txt b/errors.txt new file mode 120000 index 0000000..633a7e1 --- /dev/null +++ b/errors.txt @@ -0,0 +1 @@ +samples/errors-testing.err \ No newline at end of file diff --git a/queries.yml b/queries.yml new file mode 120000 index 0000000..355771a --- /dev/null +++ b/queries.yml @@ -0,0 +1 @@ +src/data/queries.yml \ No newline at end of file diff --git a/sova-patterns.yml b/sova-patterns.yml new file mode 120000 index 0000000..826b963 --- /dev/null +++ b/sova-patterns.yml @@ -0,0 +1 @@ +src/data/sova-patterns.yml \ No newline at end of file