Skip to content

JSON Schema: HTTP Connection Manager access log #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ccaraman merged 10 commits into from
Feb 6, 2017
Merged

JSON Schema: HTTP Connection Manager access log #412

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
705f949
put away for now
ccaraman Feb 2, 2017
53f5848
clean up
ccaraman Feb 2, 2017
ba00be1
cleaning
ccaraman Feb 2, 2017
1c84dc9
spacing
ccaraman Feb 2, 2017
37380b1
finally works
ccaraman Feb 3, 2017
28118a6
newline
ccaraman Feb 3, 2017
803ba83
int range
ccaraman Feb 3, 2017
30d5ca3
599
ccaraman Feb 3, 2017
e9cc037
random sampling
ccaraman Feb 4, 2017
532a6dc
make travis work again
ccaraman Feb 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/configuration/http_conn_man/access_log.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ format
.. _config_http_conn_man_access_log_filter_param:

filter
*(optional, string)* :ref:`Filter <config_http_con_manager_access_log_filters>` which is used to
*(optional, object)* :ref:`Filter <config_http_con_manager_access_log_filters>` which is used to
determine if the access log needs to be written.

.. _config_http_con_manager_access_log_format:
Expand Down Expand Up @@ -175,7 +175,7 @@ Duration
Filters on total request duration in milliseconds.

op
*(required, string)* Comparison operator. Currently *>=* is the only supported operator.
*(required, string)* Comparison operator. Currently *>=* and *=* are the only supported operator.

@RomanDzhabarov RomanDzhabarov Feb 2, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

operators?

@ccaraman ccaraman Feb 2, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.


value
*(required, integer)* Default value to compare against if runtime values is not available.
Expand Down
108 changes: 102 additions & 6 deletions source/common/json/config_schemas.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,93 @@ const std::string Json::Schema::HTTP_CONN_NETWORK_FILTER_SCHEMA(R"EOF(
{
"$schema": "http://json-schema.org/schema#",
"definitions" : {
"access_log": {
"status_code" : {
"type" : "object",
"properties" : {
"path" : {"type" : "string"},
"format" : {"type" : "string"},
"filter" : {"type" : "object"}
"type" : {
"type" : "string",
"enum" : ["status_code"]
},
"op" : {
"type" : "string",
"enum" : ["=>", "="]
},
"value" : {"type" : "integer"},

@rshriram rshriram Feb 3, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about mix and max here as well?
minimum 0 and maximum 600 (for http)

@ccaraman ccaraman Feb 3, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great suggestion. Added.

"runtime_key" : {"type" : "string"}
},
"required" : ["type", "op", "value"],
"additionalProperties" : false
},
"duration" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : ["duration"]
},
"op" : {
"type" : "string",
"enum" : ["=>", "="]
},
"value" : {"type" : "integer"},
"runtime_key" : {"type" : "string"}
},
"required" : ["type", "op", "value"],
"additionalProperties" : false
},
"not_healthcheck" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : ["not_healthcheck"]
}
},
"required" : ["type"],
"additionalProperties" : false
},
"logical_and" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : ["logical_and"]
},
"filters" : {

@RomanDzhabarov RomanDzhabarov Feb 3, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change looks good to me, if only we could extract "filters" from here and from logical_or into separate thing and reference it from here and other place.

@ccaraman ccaraman Feb 4, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good call. I didn't think about putting those two together at the time. Thank you!

"type" : "array",
"minItems" : 2,
"items" : {
"anyOf" : [
{"$ref" : "#/defintions/status_code"},

@RomanDzhabarov RomanDzhabarov Feb 2, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

@ccaraman ccaraman Feb 2, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

{"$ref" : "#/definitions/duration"},
{"$ref" : "#/definitions/not_healthcheck"}
]
}
}
},
"required" : ["path"],
"required" : ["type", "filters"],
"additionalProperties" : false
},
"logical_or" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : ["logical_or"]
},
"filters" : {
"type" : "array",
"minItems" : 2,
"items" : {
"anyOf" : [
{"$ref" : "#/defintions/status_code"},

@RomanDzhabarov RomanDzhabarov Feb 2, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any of the supported filter types can be here

@ccaraman ccaraman Feb 2, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

{"$ref" : "#/definitions/duration"},
{"$ref" : "#/definitions/not_healthcheck"}
]
}
}
},
"required" : ["type", "filters"],
"additionalProperties" : false
},
"tracing" : {
Expand Down Expand Up @@ -133,7 +212,24 @@ const std::string Json::Schema::HTTP_CONN_NETWORK_FILTER_SCHEMA(R"EOF(
"type" : "array",
"items" : {
"type" : "object",
"properties" : {"$ref" : "#/definitions/access_log"}
"properties" : {
"path" : {"type" : "string"},
"format" : {"type" : "string"},
"filter" : {
"type" : "object",
"properties" : {
"oneOf" : [
{"$ref" : "#/definitions/status_code"},

@RomanDzhabarov RomanDzhabarov Feb 2, 2017 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

if (type == "status_code") {
    return FilterPtr{new StatusCodeFilter(json, runtime)};
  } else if (type == "duration") {
    return FilterPtr{new DurationFilter(json, runtime)};
  } else if (type == "runtime") {
    return FilterPtr{new RuntimeFilter(json, runtime)};
  } else if (type == "logical_or") {
    return FilterPtr{new OrFilter(json, runtime)};
  } else if (type == "logical_and") {
    return FilterPtr{new AndFilter(json, runtime)};
  } else if (type == "not_healthcheck") {
    return FilterPtr{new NotHealthCheckFilter()};
  } else if (type == "traceable_request") {
    return FilterPtr{new TraceableRequestFilter(runtime)};

ref should be updated
these are all supported access log filters, why tests not catching it?

@ccaraman ccaraman Feb 2, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll add a test for nested filters

{"$ref" : "#/definitions/duration"},
{"$ref" : "#/definitions/not_healthcheck"},
{"$ref" : "#/defintions/logical_and"},
{"$ref" : "#/defintions/logical_or"}
]
}
}
},
"required" : ["path"],
"additionalProperties" : false
}
},
"use_remote_address" : {"type" : "boolean"},
Expand Down
38 changes: 30 additions & 8 deletions test/config/integration/server.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down Expand Up @@ -107,10 +118,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down
38 changes: 30 additions & 8 deletions test/config/integration/server_http2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",

@RomanDzhabarov RomanDzhabarov Feb 2, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you use '=' also in integration test configs, so that it'll have additional coverage

@ccaraman ccaraman Feb 2, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is already coverage for '=' within access_log_impl_tests.cc

@RomanDzhabarov RomanDzhabarov Feb 2, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup it's tested, just wanted extra test of that here, either way

"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down Expand Up @@ -88,10 +99,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down
57 changes: 45 additions & 12 deletions test/config/integration/server_http2_upstream.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down Expand Up @@ -82,10 +93,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down Expand Up @@ -157,10 +179,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down
19 changes: 15 additions & 4 deletions test/config/integration/server_proxy_proto.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down
19 changes: 15 additions & 4 deletions test/config/integration/server_ssl.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,21 @@
"access_log": [
{
"path": "/dev/null",
"filters": [
{"type": "status_code", "op": ">=", "value": 500},
{"type": "duration", "op": ">=", "value": 1000000}
]
"filter" : {
"type": "logical_or",
"filters": [
{
"type": "status_code",
"op": ">=",
"value": 500
},
{
"type": "duration",
"op": ">=",
"value": 1000000
}
]
}
},
{
"path": "/dev/null"
Expand Down
Loading