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.

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

adding github issues templates #70

Merged
merged 1 commit into from
Aug 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: '[BUG]'
labels: 'bug, untriaged'
assignees: ''
---

**What is the bug?**
A clear and concise description of the bug.

**How can one reproduce the bug?**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**What is the expected behavior?**
A clear and concise description of what you expected to happen.

**What is your host/environment?**
- OS: [e.g. iOS]
- Version [e.g. 22]
- Plugins

**Do you have any screenshots?**
If applicable, add screenshots to help explain your problem.

**Do you have any additional context?**
Add any other context about the problem.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: OpenSearch Community Support
url: https://discuss.opendistrocommunity.dev/
about: Please ask and answer questions here.
- name: AWS/Amazon Security
url: https://aws.amazon.com/security/vulnerability-reporting/
about: Please report security vulnerabilities here.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: 🎆 Feature request
about: Request a feature in this project
title: '[FEATURE]'
labels: 'enhancement, untriaged'
assignees: ''
---
**Is your feature request related to a problem?**
A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_

**What solution would you like?**
A clear and concise description of what you want to happen.

**What alternatives have you considered?**
A clear and concise description of any alternative solutions or features you've considered.

**Do you have any additional context?**
Add any other context or screenshots about the feature request here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/integration_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: 🎆 Integration suggestion
about: Suggest an integration
title: '[Integration]'
labels: 'integration, untriaged'
assignees: ''
---

**What is the integration resource ?**

Describe the integration resource you are interested in and attach a link to the integration resource [ [`nginx`](https://www.nginx.com/) ]

**What is the integration source protocol ?**

Describe the integration resource log protocol you are interesting in [ [`access.log`](https://nginx.org/en/docs/http/ngx_http_log_module.html?&_ga=2.217812566.1563503332.1689381945-1241118970.1689381945#log_format) ]

**What is the integration target protocol ?**

Describe the target protocol you are interested to ingest [ [`logs.mapping`](https://github.com/opensearch-project/opensearch-catalog/blob/main/schema/observability/logs/logs.mapping) , [`http.mapping`](https://github.com/opensearch-project/opensearch-catalog/blob/main/schema/observability/logs/http.mapping) ]

**Which agents would you use to ship this data ?**

Describe the agents you may be using to ship this telemetry data [ OTEL-Receiver / Fluent-bit / Telegraf / collectd ]

**Would you be using an ingestion pipeline ?**

Describe whether you may be using an ingestion pipeline to collect and enrich the data on-route [ OTEL-Collector / Data-Prepper / ADOT-Collector ]

**Which Dashboards would you be using ?**

Describe the dashboard you would like to see on-top of the ingested telemetry signals ?[Try adding screenshots & descriptions]

----

**Do you have any additional context?**

Add any other context or screenshots about the feature request here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/schema_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: 🎆 Schema modification
about: Suggest new Schema / Update Schema
title: '[Schema]'
labels: 'schema, untriaged'
assignees: ''
---

**Which domain protocol is relevant for this schema ?**

Describe the domain you may for the schema use case [ Observability / Security / Search ... ]

**What is the schema resource ?**

Describe the schema resource you are interested in update or create and attach a link to the schema resource

### Source Schema - Add necessary repository
- [OTEL](https://github.com/open-telemetry/opentelemetry-collector)
- [OCSF](https://github.com/ocsf/ocsf-schema)

----

**Do you have any additional context?**

Add any other context or screenshots about the feature request here.