Add 'summary_table_max_rows' configuration option

[ghost]

Description

There is currently no way of limiting the number of rows in a summary_table. This can lead to very long "summary" tables that can break formatting when sending notifications.

Checklist

• I have reviewed the contributing guidelines.
• I have included unit tests for my changes or additions.
• I have successfully run make test-docker with my changes.
• I have manually tested all relevant modes of the change in this PR.
• I have updated the documentation.
• I have updated the changelog.

Questions or Comments

This is a small code change. I've been running this for a few days, there have been no issues.

[nsano-rururu]

@mdavyt92

Does that mean adding a setting called summary_table_max_rows? .. If so, I think the documentation needs to be modified.
Also, schema.yaml
https://github.com/jertel/elastalert2/blob/master/docs/source/ruletypes.rst
https://github.com/jertel/elastalert2/blob/master/elastalert/schema.yaml

[nsano-rururu]

Please also update the change log.

[ghost]

Updated documentation and changelog. Not sure what to do with the schema

[nsano-rururu]

Updated documentation and changelog. Not sure what to do with the schema

Is it a character? Is it a number? If it is a number, is there a range that can be set? .. Does that mean that decimal points are not allowed?

[ghost]

It's a non negative integer.
I searched for summary_table_fields or summary_table_type in the schema to use as template, but I found nothing.

[nsano-rururu]

It's a non negative integer. I searched for summary_table_fields or summary_table_type in the schema to use as template, but I found nothing.

The reason why there is no setting. Dunno. I didn't make it.
Since the validation check setting itself was added later, there is no problem in itself that there is no setting.
Also add the following settings above the ### Kibana Discover App Link.
Check the operation locally and make a pull request if there is no problem when executing the rule.

### summary table
summary_table_fields: {type: array, items: {type: string}}
summary_table_type: {type: string, enum: ['ascii', 'markdown']}
summary_table_max_rows: {type: number}
summary_prefix: {type: string}
summary_suffix: {type: string}

[nsano-rururu]

@jertel

Is there anything else you care about?

[jertel]

@mdavyt92 Please add a unit test to alerts_test.py for this new option. You can use test_alert_aggregation_summary_default_table as a template and configure the new summary_table_max_rows setting to limit it to 1 row, then assert that the cde from match row doesn't exist in the output summary_table variable.

[jertel]

Thanks for the new summary table max rows param!

[nsano-rururu]

@jertel

I made a mistake in pointing out the review. I'm sorry. With the current settings, negative and decimal values are also allowed. Correctly, you need to modify schema.yaml as follows.

summary_table_max_rows: {type: number}

　　　　　　　　↓

summary_table_max_rows: {type: integer, 'minimum': 0}

[jertel]

Thanks for the heads-up @nsano-rururu. I've pushed the change directly to master: 0ec9179

I don't think the single quotes are required since other schema.yaml lines did not specify 'minimum': but rather minimum:.

[nsano-rururu]

@jertel

surely. No single quotes required. We apologize for including unnecessary information.
In addition, the operation check of json schema was done with the following code.

import jsonschema

schema = {
     "type" : "object",
     "properties" : {
         "price" : {"type" : "integer", "minimum": 0},
         "name" : {"type" : "string"},
         "to" : {"type" : "string", "format": "email"},
         "url" : {"type" : "string", "format": "uri"}
     },
 }

try:
    jsonschema.validate(instance={"name" : "1", "price" : 1, "to": "aaa@abc.com", "url" : "100"}, schema=schema, format_checker=jsonschema.FormatChecker())
except Exception as e:
    print(e)

price is 1

(myvenv) [CORP\sano@a-ngft53r34ong pywork]$ python json2.py 

price is -1

(myvenv) [CORP\sano@a-ngft53r34ong pywork]$ python json2.py 
-1 is less than the minimum of 0

Failed validating 'minimum' in schema['properties']['price']:
    {'minimum': 0, 'type': 'integer'}

On instance['price']:
    -1

price is 0.2

(myvenv) [CORP\sano@a-ngft53r34ong pywork]$ python json2.py 
0.2 is not of type 'integer'

Failed validating 'type' in schema['properties']['price']:
    {'minimum': 0, 'type': 'integer'}

On instance['price']:
    0.2