github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/issue_template.md (about)

     1  # Filing M3 Issues
     2  
     3  ## General Issues
     4  
     5  General issues are any non-performance related issues (data integrity, ease of use, error messages, configuration, documentation, etc).
     6  
     7  Please provide the following information along with a description of the issue that you're experiencing:
     8  
     9  1. What service is experiencing the issue? (M3Coordinator, M3DB, M3Aggregator, etc)
    10  2. What is the configuration of the service? Please include any YAML files, as well as namespace / placement configuration (with any sensitive information anonymized if necessary).
    11  3. How are you using the service? For example, are you performing read/writes to the service via Prometheus, or are you using a custom script?
    12  4. Is there a reliable way to reproduce the behavior? If so, please provide detailed instructions.
    13  
    14  ## Performance issues
    15  
    16  If the issue is performance related, please provide the following information along with a description of the issue that you're experiencing:
    17  
    18  1. What service is experiencing the performance issue? (M3Coordinator, M3DB, M3Aggregator, etc)
    19  2. Approximately how many datapoints per second is the service handling?
    20  3. What is the approximate series cardinality that the series is handling in a given time window? I.E How many unique time series are being measured?
    21  4. What is the hardware configuration (number CPU cores, amount of RAM, disk size and types, etc) that the service is running on? Is the service the only process running on the host or is it colocated with other software?
    22  5. What is the configuration of the service? Please include any YAML files, as well as namespace / placement configuration (with any sensitive information anonymized if necessary).
    23  6. How are you using the service? For example, are you performing read/writes to the service via Prometheus, or are you using a custom script?
    24  
    25  In addition to the above information, CPU and heap profiles are always greatly appreciated.
    26  
    27  ### CPU / Heap Profiles
    28  
    29  CPU and heap profiles are critical to helping us debug performance issues. All our services run with the [net/http/pprof](https://golang.org/pkg/net/http/pprof/) server enabled by default.
    30  
    31  Instructions for obtaining CPU / heap profiles for various services are below, please attach these profiles to the issue whenever possible.
    32  
    33  #### M3Coordinator
    34  
    35  CPU
    36  `curl <HOST_NAME>:<PORT(default 7201)>/debug/pprof/profile?seconds=5 > m3coord_cpu.out`
    37  
    38  Heap
    39  `curl <HOST_NAME>:<PORT(default 7201)>/debug/pprof/heap > m3coord_heap.out`
    40  
    41  #### M3DB
    42  
    43  CPU
    44  `curl <HOST_NAME>:<PORT(default 9004)>/debug/pprof/profile?seconds=5 > m3db_cpu.out`
    45  
    46  Heap
    47  `curl <HOST_NAME>:<PORT(default 9004)>/debug/pprof/heap -> m3db_heap.out`
    48  
    49  ### M3DB Grafana Dashboard Screenshots
    50  
    51  If the service experiencing performance issues is M3DB and you're monitoring it using Prometheus, any screenshots you could provide using [this](https://grafana.com/grafana/dashboards/8126-m3db-node-details/) dashboard would be helpful.