Skip to content
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

Jump to bottom

Create JSON Schema for events and metrics #725

Closed
iapaddler opened this issue Jan 24, 2022 · 1 comment · Fixed by #765
Closed

Create JSON Schema for events and metrics #725

iapaddler opened this issue Jan 24, 2022 · 1 comment · Fixed by #765
Assignees
@michalbiesek
Labels
libscope
Milestone
1.0.0

Comments

@iapaddler
Copy link
Contributor

Per the investigation performed as described in #720, we are creating JSON schema for events and metrics. The design rules are defined in issue #723.
@iapaddler iapaddler added this to the Next Major (1.0.0) milestone Jan 24, 2022
@michalbiesek michalbiesek mentioned this issue Jan 25, 2022
Closed
michalbiesek added a commit to michalbiesek/appscope that referenced this issue Feb 4, 2022
@michalbiesek
Add JSON schema
ba45b80 
Events

1. Raw events:

- fs.duration
- fs.error
- fs.read
- fs.seek
- fs.stat
- fs.write
- net.duration
- net.error
- net.port
- net.rx
- net.other
- net.tcp
- net.tx
- net.udp
- notice (rateLimitMessage)
- stderr
- stdout

2. Standard events:

- dns.req
- dns.resp
- fs.close
- fs.open
- http.req
- http.resp
- net.close
- net.open

Added new target `make doc-generation`

- fix JSON schema for http metrics with summary

close criblio#725.
@michalbiesek michalbiesek linked a pull request Feb 4, 2022 that will close this issue
Json Schema #727
Closed
@michalbiesek
Copy link
Contributor

michalbiesek commented Feb 4, 2022 •
edited

PR #727 address the issue.

Implementation details are below:

  • JSON-Schemas for each of the metrics and events are stored in docs/schemas directory
  • short manual of how to maintain the schemas is presented here docs/schemas/README.md
  • to generate documentation in form of the markdown files based on the JSON Schema call in top directory of Appscope project:
make docs-generate

This will result in the creation of Markdown files and put them in docs/md_files

With latest commit:

  • I have added an examples validation, It checks examples presented in the Schema against the current state of JSON-schema: besides validate against the schema it checks if any additional fields presented in the example is described by the current schema - see link for details

michalbiesek added a commit to michalbiesek/appscope that referenced this issue Feb 7, 2022
@michalbiesek
Add JSON schema
9104b95 
Events

1. Raw events:

- fs.duration
- fs.error
- fs.read
- fs.seek
- fs.stat
- fs.write
- net.duration
- net.error
- net.port
- net.rx
- net.other
- net.tcp
- net.tx
- net.udp
- notice (rateLimitMessage)
- stderr
- stdout

2. Standard events:

- dns.req
- dns.resp
- fs.close
- fs.open
- http.req
- http.resp
- net.close
- net.open

Added new target `make doc-generation`

- fix JSON schema for http metrics with summary

close criblio#725.
michalbiesek added a commit to michalbiesek/appscope that referenced this issue Feb 7, 2022
@michalbiesek
Add JSON schema
205cc22 
Events

1. Raw events:

- fs.duration
- fs.error
- fs.read
- fs.seek
- fs.stat
- fs.write
- net.duration
- net.error
- net.port
- net.rx
- net.other
- net.tcp
- net.tx
- net.udp
- notice (rateLimitMessage)
- stderr
- stdout

2. Standard events:

- dns.req
- dns.resp
- fs.close
- fs.open
- http.req
- http.resp
- net.close
- net.open

Added new target `make doc-generation`

- fix JSON schema for http metrics with summary

close criblio#725.
michalbiesek added a commit to michalbiesek/appscope that referenced this issue Feb 7, 2022
@michalbiesek
Add JSON schema
19fdf5d 
Events

1. Raw events:

- fs.duration
- fs.error
- fs.read
- fs.seek
- fs.stat
- fs.write
- net.duration
- net.error
- net.port
- net.rx
- net.other
- net.tcp
- net.tx
- net.udp
- notice (rateLimitMessage)
- stderr
- stdout

2. Standard events:

- dns.req
- dns.resp
- fs.close
- fs.open
- http.req
- http.resp
- net.close
- net.open

Added new target `make doc-generation`

- fix JSON schema for http metrics with summary

close criblio#725.
@michalbiesek michalbiesek linked a pull request Feb 8, 2022 that will close this issue
Json Schema #765
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michalbiesek michalbiesek

Labels
libscope
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Json Schema criblio/appscope
Json Schema michalbiesek/appscope
2 participants
@iapaddler @michalbiesek