Skip to content

Commit 338d2e8

Browse files
authored
Add issue template specific for PPL commands and queries (opensearch-project#3962)
* Add issue template specific for PPL commands and queries Signed-off-by: Anas Alkouz <aalkouz@amazon.com> * Add section for Dataset/schema information, add reminders for the customers to remove any sensitive datas Signed-off-by: Anas Alkouz <aalkouz@amazon.com> --------- Signed-off-by: Anas Alkouz <aalkouz@amazon.com>
1 parent 5316c0a commit 338d2e8

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: 🐛 PPL Bug Report
3+
about: Report a bug or unexpected behavior in PPL
4+
title: '[BUG] Brief description of the issue'
5+
labels: 'bug, untriaged, PPL'
6+
assignees: ''
7+
---
8+
## Query Information
9+
**PPL Command/Query:**
10+
```ppl
11+
# Paste your PPL command or query here
12+
# Remember to sanitize any sensitive fields or values
13+
```
14+
**Expected Result:**
15+
<!-- Describe what you expected to happen -->
16+
17+
**Actual Result:**
18+
<!-- Describe what actually happened, including any error messages -->
19+
<!-- Make sure to redact any sensitive information in error messages -->
20+
21+
## Dataset Information
22+
**Dataset/Schema Type**
23+
- [x] OpenTelemetry (OTEL)
24+
- [ ] Simple Schema for Observability (SS4O)
25+
- [ ] Open Cybersecurity Schema Framework (OCSF)
26+
- [ ] Custom (details below)
27+
28+
**Index Mapping**
29+
```json
30+
{
31+
"mappings": {
32+
"properties": {
33+
"field_name": { "type": "type" }
34+
// Add your index mapping here
35+
// Replace sensitive field names with generic alternatives
36+
}
37+
}
38+
}
39+
```
40+
**Sample Data**
41+
```json
42+
{
43+
// Add sample document that reproduces the issue
44+
// Use dummy/anonymized data for sensitive fields
45+
// Example: Replace real IPs with 10.0.0.x, real emails with user@example.com
46+
}
47+
```
48+
49+
## Bug Description
50+
**Issue Summary:**
51+
<!-- A clear and concise description of what the bug is -->
52+
53+
**Steps to Reproduce:**
54+
1.
55+
2.
56+
3.
57+
58+
**Impact:**
59+
<!-- Describe how this bug affects your use case -->
60+
61+
## Environment Information
62+
**OpenSearch Version:**
63+
<!-- e.g., OpenSearch 2.19 -->
64+
65+
**Additional Details:**
66+
<!-- Any other relevant environment information -->
67+
<!-- Exclude sensitive infrastructure details -->
68+
69+
## Screenshots
70+
<!-- If applicable, add screenshots to help explain your problem -->
71+
<!-- ⚠️ IMPORTANT: Ensure screenshots don't contain sensitive information -->

0 commit comments

Comments
 (0)