Writing steps to reproduce

What to include in the report?

Good example

Bad example

Indicate whether you can reproduce the bug reliably or not.

I can reproduce using the following steps:

Precisely describe which URLs with example payloads to reproduce the issue.

When I send a request to http://localhost:8080/ncmp/v1/ch/id-searches with the following JSON:

{"cmHandleQueryParameters":[{"conditionName":"hasAllModules","conditionParameters":[{"moduleName":"ietf-yang-types-1"}]}]}

I perform a search for a module

Accurately describe the expected and actual results.

Expected Results: The search takes 2 seconds to complete.
Actual Results: The search takes 10 minutes.

It takes a long time

Bug Reporting Template

A bug report should contain the following information, where applicable:

Clear description of the issue
Clear Steps to Reproduce
Affected version(s) - ideally, you should test with latest
Expected behaviourbehavior
Actual behaviourbehavior
Impact - this is important for us to prioritize tickets
Clear Steps to Reproduce
Environment (Docker, Kubernetes, etc.)(Optional) Attached artifacts: Screenshots, Logs, Test data, etc.
- Alternatively, attach the corresponding client-specific Jira or other place where such artifacts can be accessedshared.

Environment info should include available resources in the deployment (memory and CPU cores, number of application instances).
What is the load on the system at the time? (how many concurrent operations)
What is the size of data set being used? How many CM-handles?
Measured CPU and memory consumption, if known.
For Out Of Memory Errors (OOMEs): a heap dump from during the OOME would be useful.
Generally, a Database SQL dump that can reproduce the issue would be ideal.

...

When I send a request to http://localhost:8080/ncmp/v1/ch/id-searches with the following JSON:

{"cmHandleQueryParameters":[{"conditionName":"hasAllModules","conditionParameters":[{"moduleName":"ietf-yang-types-1"}]}]}

...

...