Commit Graph

135 Commits (48287b15d4fe3a2c9578982bdffeccdc0e14d1ef)

Author SHA1 Message Date
Fiona Liao d7c8177f56
docs: update README with v3 tagging update (#15361)
docs: update README with v3 tagging update

Signed-off-by: Fiona Liao <fiona.liao@grafana.com>

---------

Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
2024-11-20 16:46:11 +01:00
Nathan Baulch 50cd453c8f
chore: Fix typos (#14868)
* Fix typos

---------

Signed-off-by: Nathan Baulch <nathan.baulch@gmail.com>
2024-09-10 22:32:03 +02:00
Matthieu MOREL 2880ee8e46 chore: provide OSSF security insight
Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>
2024-07-31 06:36:02 +00:00
parnavh c92a5773b2 fix: broken link on github mobile
Signed-off-by: parnavh <parnav100sach@gmail.com>
2024-06-08 20:23:46 +05:30
Matthias Loibl 0b38a5b774
Update go get buf.build in README.md
The old import path stopped working. 

```
go get go.buf.build/protocolbuffers/go/prometheus/prometheus
go: unrecognized import path "go.buf.build/protocolbuffers/go/prometheus/prometheus": https fetch: Get "https://go.buf.build/protocolbuffers/go/prometheus/prometheus?go-get=1": dial tcp: lookup go.buf.build on 192.168.2.1:53: no such host
```

We should instead tell users to use the new import paths. 

Signed-off-by: Matthias Loibl <mail@matthiasloibl.com>
2024-02-15 12:12:36 +01:00
Matthieu MOREL 7bbae70b40
Update OSSF badge link (#13433)
Provide a more user friendly interface

Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>
2024-01-23 15:08:22 +00:00
Gabriela Gutierrez 9a628bb1c8 Add OpenSSF Scorecard badge to README.md
Signed-off-by: Gabriela Gutierrez <gabigutierrez@google.com>
2023-09-29 13:21:05 +02:00
Patryk Prus 0032ce0644
Render background in images to play nicely with dark mode
Signed-off-by: Patryk Prus <p@trykpr.us>
2023-02-26 22:56:57 -05:00
Levi Harrison 9067c31726 Remove gnu-tar note
Signed-off-by: Levi Harrison <git@leviharrison.dev>
2022-12-21 10:35:26 -04:00
Julien Pivotto 6b53aeb012
README: Remove mentions of circleci (#11580)
Signed-off-by: Julien Pivotto <roidelapluie@o11y.eu>

Signed-off-by: Julien Pivotto <roidelapluie@o11y.eu>
2022-11-17 11:18:38 +01:00
Raihan Nismara bfd320e186
Update README.md (#11413)
* Update README.md

using logo prometheus in readme that looks nicer

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Update README.md

changing the logo in readme using the orange one and reduce the size

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Add files via upload

add logo orange

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Update README.md

update logo orange in readme using local path

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Delete logo-prometheus-orange.png

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Added logo to the documentation folder

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Update logo in readme.md

- update logo using svg in readme
- fix target property in link

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Rename Prometheus_software_logo.svg to prometheus-logo

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* Rename prometheus-logo to prometheus-logo.svg

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

* update prometheus logo name file

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>

Signed-off-by: Raihan Nismara <31585789+raihan71@users.noreply.github.com>
2022-10-09 11:42:28 +02:00
Levi Harrison 59727ab0eb
Make clear that `go install` needs to be run in the cloned repo (#10866)
* `go install` in cloned repo

Signed-off-by: Levi Harrison <git@leviharrison.dev>

* Removing cloning to gopath

Signed-off-by: Levi Harrison <git@leviharrison.dev>

* Change wording

Signed-off-by: Levi Harrison <git@leviharrison.dev>
2022-06-13 22:00:27 +02:00
TJ Hoplock 69beb3f23d
fix: update docs to reflect new go 1.17 version minimum (#10780)
The minimum go version was bumped to 1.17 in
29b58448e1, but the main README still
referenced go 1.16 as the minimum version required. This updates that.

I took a quick look through the other docs in the repo (ie, I did some
naive grepping), and this is the only reference I spotted.

Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
2022-05-31 13:37:05 +02:00
André Bauer 8cc27af6eb
fix markdown lint issues (#10591)
Signed-off-by: André Bauer <andre.bauer@staffbase.com>
2022-05-03 10:59:09 +02:00
beorn7 01d90aef3c README.md: Cease to call the React UI "new experimental"
Signed-off-by: beorn7 <beorn@grafana.com>
2022-04-27 17:26:02 +02:00
beorn7 5d7b929e77 README.md: Update Godoc link
Signed-off-by: beorn7 <beorn@grafana.com>
2022-04-27 14:15:39 +02:00
Julien Pivotto 624967fdbf
Add note about Prometheus as a library (#10594)
* Add note about Prometheus as a library

Signed-off-by: Julien Pivotto <roidelapluie@o11y.eu>
2022-04-14 22:23:47 +02:00
Julien Pivotto 7c370e5af9
Document plugins (#10496)
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2022-03-29 15:48:48 +02:00
SuperQ 41b43c3b87
Update minimum Go version
Update minimum required Go version to 1.16 due to use of standard
library package `io/fs`.

Signed-off-by: SuperQ <superq@gmail.com>
2021-12-31 17:29:00 +01:00
Dieter Plaetinck 0fac9bb859
Add basic initial developer docs for TSDB (#9451)
* Add basic initial developer docs for TSDB

There's a decent amount of content already out there (blog posts,
conference talks, etc), but:
* when they get stale, they don't tend to get updated
* they still leave me with questions that I'ld like to answer
  for developers (like me) who want to use, or work with, TSDB

What I propose is developer docs inside the prometheus
repository.  Easy to find and harness the power of the community
to expand it and keep it up to date.

* perfect is the enemy of good.  Let's have a base and incrementally improve
* Markdown docs should be broad but not too deep.  Source code comments
  can complement them, and are the ideal place for implementation details.

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* use example code that works out of the box

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* Apply suggestions from code review

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* PR feedback

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* more docs

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* PR feedback

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* Apply suggestions from code review

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com>

* Apply suggestions from code review

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>

* feedback

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* Update tsdb/docs/usage.md

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>

* final tweaks

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* workaround docs versioning issue

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* Move example code to real executable, testable example.

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* cleanup example test and make sure it always reproduces

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* obtain temp dir in a way that works with older Go versions

Signed-off-by: Dieter Plaetinck <dieter@grafana.com>

* Fix Ganesh's comments

Signed-off-by: Ganesh Vernekar <ganeshvern@gmail.com>

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com>
Co-authored-by: Ganesh Vernekar <ganeshvern@gmail.com>
2021-11-17 15:51:27 +05:30
Olivier Lemasle 8858a276c2
Fix link to React App's README (#9532)
Signed-off-by: Olivier Lemasle <olivier.lemasle@apalia.net>
2021-10-19 12:08:00 -04:00
Augustin Husson 08011925a1
update documentation around react-app (#9476)
* update documentation around react-app and how to upgrade the npm dependencies

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* wording around caution to take when updating the deps

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* fixing the npm version to be used and explain where you should perform the npm install command

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* simplify what is required to build prometheus from the source

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* aligned period and removed redondant word installed

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* set nodeJS version to be used at 16

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* describe manuel steps to update a dependency for the react-app

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>

* rewording of the manuel step to update the dependencies

Signed-off-by: Augustin Husson <husson.augustin@gmail.com>
2021-10-18 12:47:31 +02:00
sennatitcomb 9e7ae7b9ac Typo fixes
Signed-off-by: sennatitcomb <senna.titcomb@intel.com>
2021-09-17 15:48:02 -07:00
Frederic Hemberger 16b8911b1a
docs: Replace `go get` with `go install` for command installation (#9098)
`go get` is deprecated for installation of commands as of go v1.17
Ref: https://go.googlesource.com/go/+/ced0fdbad0655d63d535390b1a7126fd1fef8348

Signed-off-by: Frederic Hemberger <mail@frederic-hemberger.de>
2021-08-27 11:08:21 +02:00
Augustin Husson 7291563d4d
replace yarn by npm (#9198)
Signed-off-by: Augustin Husson <husson.augustin@gmail.com>
2021-08-12 20:25:26 +02:00
Levi Harrison 4a4882d4c7 Replace godoc.org links
Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-06-17 07:18:51 -04:00
Levi Harrison b59822904d
Add command to docker build instructions (#8944)
Signed-off-by: Levi Harrison <git@leviharrison.dev>
2021-06-15 23:16:21 +02:00
krrybarc bc53e7b98c Fix the installation from source instruction in README
Signed-off-by: krrybarc <981627+knrybarczyk@users.noreply.github.com>
2021-03-11 16:24:15 +01:00
Julien Pivotto 432d5ebc6c Rename default branch to main
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-22 20:28:02 +01:00
Tom Wilkie 74e0614b5c Add instructions for building docker image locally to README.md
Fixes #8442

Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
2021-02-12 13:47:41 +00:00
Julien Pivotto 715b802dba Add fuzzing badge in readme
From https://google.github.io/oss-fuzz/getting-started/new-project-guide/

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2021-02-07 23:48:46 +01:00
Julien Pivotto c666879e3f Remove fuzzit
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-12-09 21:10:31 +01:00
Kuntal Majumder 3093755174
bump the minimum required go version to build to 1.4 (#8196)
Signed-off-by: Kuntal Majumder <kuntal@infracloud.io>
2020-11-18 17:16:33 +00:00
Anthony D'Atri 2cbc0f9bfe
Various doc tweaks (#8111)
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-27 09:50:37 +00:00
Piper 712477be5a
docs: fix "timeseries" -> "time series" in README.md (#8107)
Signed-off-by: Piper <piperchester@gmail.com>
2020-10-24 10:27:24 +01:00
Ricky Pai fa8722be4a
add link to circleci config in README (#8089)
Signed-off-by: Ricky Pai <rickyp999+github@gmail.com>
2020-10-21 09:37:18 +02:00
Luke Chen 68d65a8ac5
Add the "assets" make target and change directory note in readme (#7908)
* add the "assets" make target and change directory note in readme

Signed-off-by: Luke Chen <showuon@gmail.com>

* address reviewer's comment

Signed-off-by: Luke Chen <showuon@gmail.com>
2020-09-16 15:01:48 +02:00
Julien Pivotto 10363c442a
README: Remove direct reference to debian packages (#7796)
We respect and appreciate the work made by the packaging team downstream
in Debian, however it seems that the package is deviating in a way that
I'd like to remove the direct reference from our README:

- The debian package is deviating from upstream in multiple ways:
  - Some Service discoveries are missing (Azure, Kubernetes)
  - The lock file is disabled and the flag has been renamed
  - The libraries are not at the same release
  - The new UI is not implemented
- We have no control over the backports and the quick availability of
  updates
- There are other distributions with different packages and we do not
  include them either
- I expect Debian users to look in their distribution and just see the
  package there 'as usual'

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-08-17 20:33:46 +02:00
Sven Efftinge 605371c5bb
Gitpod config (#7749)
Signed-off-by: Sven Efftinge <sven.efftinge@typefox.io>
2020-08-14 17:23:55 +02:00
Julius Volz e393f42ce3 Mention PromQL in README.md
Signed-off-by: Julius Volz <julius.volz@gmail.com>
2020-08-04 22:38:08 +02:00
Krasimir Georgiev ddd49b743c
Update README.md 2020-01-27 18:10:08 +02:00
Krasimir Georgiev cf6144a98f
Update README.md 2020-01-27 18:09:00 +02:00
Julius Volz 4be90b201e
Remove Travis as a CI platform (#6369)
It's currently causing weird unknown problems in React tests that run
successfully everywhere else, and by now all the tests that run on
Travis also run on CircleCI, so Travis is not needed anymore.

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2019-11-25 14:59:26 +01:00
Julius Volz d2a3ef2f12
Remove broken Travis badge (#6364)
The "green" status of this badge was actually last updated 4 years ago,
until I manually ran a master branch test today that made the current
Travis test failures in the React tests visible. But those test failures
seem to be Travis-related and not real (the same tests pass on
CircleCI). Maybe we can completely remove Travis by now, but let's
remove the now-failing badge for now to not scare users.

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2019-11-23 23:13:40 +01:00
Julius Volz 85cae37107
React UI: Add better docs for the React UI (#6315)
* React UI: Add better docs for the React UI

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fixups

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fixup

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2019-11-14 19:53:10 +01:00
Sally Lehman 2d8b6c7792 link example when the config file is first named in the README (#6294)
Signed-off-by: Sally Lehman <slehman@ripple.com>
2019-11-09 09:48:09 +01:00
Julius Volz bca6e90ea6
Integrate beginning of React UI (#5694)
* Initial commit from Create React App

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Initial Prometheus expression browser code

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Grpahing, try out echarts

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Switch to flot

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add metrics fetching and stuff

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Autosuggest and graph improvements

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Start implementing graph controls, add loading spinner

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* So many new features and fixes

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fixed and built more features

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Make datetimepicker clear work

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Don't abort when executing empty expression

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove TabPaneAlert

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Split components into separate files

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add table time input

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Move first files to TypeScript!

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* More TypeScript conversions

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* More TS conversions

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* More TS conversions

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* More TS conversions

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* More TS conversions

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* More TS fixes

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Convert Graph to TS

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Changes

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Resize detector, start building legend, axis font colors

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Make graph legend work

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add URL params support and much more

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Put panel state into panel list, write URL options

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Change order of Graph and Table tabs

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Generalize time input naming more

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Work on history functionality

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* npm updates

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Move loading indicator into "Execute" button

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fix typo

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Revert "Move loading indicator into "Execute" button"

This reverts commit ce7daee1f1af35da6c0d8b5517272839285ccfec.

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Improve error message when failing to fetch server time

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Move all code to Prometheus repo target dir

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add react-app Makefile step and check in generated assets

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add preliminary npm packages notice to NOTICE file

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Update React app's favicon and metadata

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove RP server refs, cleanups

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Use CircleCI image that includes NodeJS

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add some missing React output assets

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Preserve CRLF in generated React files

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Switch from npm to yarn for React UI

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Save npm licenses and include them in release tarball

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Install npm on Travis

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove npm license tarball from source

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove React graph bundle from source

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Don't check in any compiled web assets

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Update README.md with node/yarn/React UI info

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fix asset build step on CircleCI promu crossbuild

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Try to fix multi-arch go generate

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove check_assets from Travis CI build

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Prevent rebuilding of unchanged React app parts

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fix npm license tarball path for promu

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Simplify Makefile

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Clarify build instructions in README.md

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Make minimal JS test pass

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Integrate React app tests into Makefile

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Separate react-app-tests target, but run it from CI

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fix working directory for React app tests

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove local modifications to Makefile.common

This means that CircleCI will not run the React app tests, but at least
Travis still will...

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Depend on node_modules path for npm_licenses target

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Simplify tarball/docker/build Makefile targets

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Include React tests in "test" target

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Remove reference to removed "check_assets" target

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Do initial resize of expression input field

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add React app proxying to local Prometheus in dev mode

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2019-10-17 14:38:09 +02:00
abejidefemi1@gmail.com 5264b9628b fix punctuation mark
fix typo
Signed-off-by: abejidefemi1@gmail.com <abejidefemi1@gmail.com>
2019-10-01 09:02:11 +01:00
Simon Pasquier ca424695a6 *: bump Go version to 1.13 (#6020)
* *: bump Go version to 1.13
* Fix go.mod for k8s.io/client-go

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2019-09-13 13:55:18 +01:00
Yevgeny Pats 0e1767ba93 Add Continuous Fuzzing via Fuzzit (#5890)
* add fuzzit.dev continuous fuzzing integration

Signed-off-by: Krzysztof Kowalczyk <kkowalczyk@gmail.com>

* Migration to Circle

Signed-off-by: Yevgeny Pats <yp@fuzzit.dev>
2019-08-21 10:43:53 +02:00