Skip to content
This repository has been archived by the owner on Jan 19, 2022. It is now read-only.
/ qan-api Public archive

Query Analytics API for PMM 1.x

License

Notifications You must be signed in to change notification settings

percona/qan-api

Repository files navigation

Percona Query Analytics API

Travis CI Build Status GoDoc Report Card CLA assistant

Percona Query Analytics (QAN) API is part of Percona Monitoring and Management (PMM). See the PMM docs for more information.

##Building

In the empty dir run:

export GOPATH=$(pwd)
git clone http://github.com/percona/qan-api ./src/github.com/percona/qan-api
go build -o ./revel ./src/github.com/percona/qan-api/vendor/github.com/revel/cmd/revel
ln -s $(pwd)/src/github.com/percona/qan-api/vendor/github.com/revel src/github.com/revel
./revel build github.com/percona/qan-api <destination dir> prod

Submitting Bug Reports

If you find a bug in Percona QAN API or one of the related projects, you should submit a report to that project's JIRA issue tracker.

Your first step should be to search the existing set of open tickets for a similar report. If you find that someone else has already reported your problem, then you can upvote that report to increase its visibility.

If there is no existing report, submit a report following these steps:

  1. Sign in to Percona JIRA. You will need to create an account if you do not have one.
  2. Go to the Create Issue screen and select the relevant project.
  3. Fill in the fields of Summary, Description, Steps To Reproduce, and Affects Version to the best you can. If the bug corresponds to a crash, attach the stack trace from the logs.

An excellent resource is Elika Etemad's article on filing good bug reports..

As a general rule of thumb, please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing tickets.
  • Scoped to a Single Bug. One bug per report.