The alerta-docs from alerta

[docs] Alert duplicateCount should be duplicate_count

Fix tutorial 3. duplicate count isn't readable during before alert hits database. how does this work?

Tutorial 1 does not mention HTML 5 history mode

Hi
should https://docs.alerta.io/en/latest/gettingstarted/tutorial-1-deploy-alerta.html not include the configuration specified in
https://github.com/alerta/alerta-webui#html5-history-mode
to avoid running into issues as alerta/alerta-webui#200
like so

    location / {
            root /var/www/html;
            try_files $uri $uri/ /index.html;
    }

Housekeeping

Please can you clarify what is required in terms of manual housekeeping now? The docs still mention housekeepingAlerts.js, but I'm running with PostgreSQL so that's not an option.

I see there is a /management/housekeeping view, that I could hit with curl, but should I?

We can use alerta CLI to do the heartbeats, so that's not a concern: alerta heartbeats --alerta

I'm happy to bring the documentation up-to-date if you can confirm.

Thanks,
Mike

Quick start guide missing command to install alerta

In the "Send some alerts" section, there should be one more command:

pip3 install alerta

Fix Sphinx nitpick warning, link check errors and spelling mistakes

See https://github.com/alerta/alerta-docs/runs/4318069695?check_suite_focus=true

The instruction how to start and enable MongoDB is incorrect

Issue Summary
I follow the instruction at docs.alerta.io Deploying an Alerta Server

The section
$ sudo service start mongodb
$ sudo service status mongodb
$ sudo service enable mongodb

I needed to replace it with
$ sudo systemctl start mongod
$ sudo systemctl status mongod
$ sudo systemctl enable mongod

Environment

OS: Ubuntu 18.04.5 LTS

Document keycloak auth provider

Follows alerta/alerta#347 and alerta/angular-alerta-webui#73

Create User endpoint has been deprecated

Replaced with /auth/signup...
Example

curl -XPOST http://localhost:8080/auth/signup \
-H 'Authorization: Key demo-key' \
-H 'Content-type: application/json' \
-d '{
      "name": "Joe Bloggs",
      "email": "[email protected]",
      "password": "secret",
      "text": "demo user"
    }’

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI4Y2IwYjYyNC0zY2Q3LTQ1YjktOThhNS01ZGZhYzVmMDE2NmMiLCJyb2xlcyI6WyJ1c2VyIl0sImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC8iLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJqb2UuYmxvZ2dzQGV4YW1wbGUuY29tIiwibmFtZSI6IkpvZSBCbG9nZ3MiLCJlbWFpbCI6ImpvZS5ibG9nZ3NAZXhhbXBsZS5jb20iLCJzY29wZSI6InJlYWQgd3JpdGUiLCJqdGkiOiI2ODlhMmY3Yy0zNTJlLTQ5M2ItYWZjYi1iOWUwOTE3ODAyMDgiLCJleHAiOjE1MTMxODIxNDcsInByb3ZpZGVyIjoiYmFzaWMiLCJpYXQiOjE1MTE5NzI1NDcsIm5iZiI6MTUxMTk3MjU0NywiYXVkIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwLyJ9.c5jpr8YksoJmoZ6KUwsYP5fgwZr-jdA4W3JUCbv1vXU"
}

[docs] Update docs

general

server settings 6fd0aa6
web ui - currently only headings
integrations - webhooks are incomplete
customer views - almost nothing

tutorials

reference

API
alert format
heartbeat format

first install issue

I'm trying to get a first install to life.
It is more a tenth install now, so I make an issue out of it, since it should be working according to the documentation.

Install: opensuse tumbleweed VM (minimal+plus required packages listed)

I tried installing from github master,
I did follow the install.sh for debian (adapted)

I disabled auth, but on the angular-web-ui I get login / signup, and signup fails.
when I try alerta on the cli, I get various errors:

 alerta query --filters text=~disk
 Error: no such option: --filters

on other commands I get unexplained json errors (see below).
I do have a running alertad process, and I have deployed and modified flask apps in the past, so I think my basic setup should be acceptable, at least enough to produce speaking errors.

alerta top
Traceback (most recent call last):
  File "/usr/bin/alerta", line 11, in <module>
    sys.exit(cli())
  File "/usr/lib64/python3.6/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib64/python3.6/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/usr/lib64/python3.6/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib64/python3.6/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib64/python3.6/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/usr/lib64/python3.6/site-packages/click/decorators.py", line 27, in new_func
    return f(get_current_context().obj, *args, **kwargs)
  File "/usr/lib/python3.6/site-packages/alertaclient/commands/cmd_top.py", line 15, in cli
    screen.run()
  File "/usr/lib/python3.6/site-packages/alertaclient/top.py", line 26, in run
    wrapper(self.main)
  File "/usr/lib64/python3.6/curses/__init__.py", line 94, in wrapper
    return func(stdscr, *args, **kwds)
  File "/usr/lib/python3.6/site-packages/alertaclient/top.py", line 69, in main
    self.update()
  File "/usr/lib/python3.6/site-packages/alertaclient/top.py", line 83, in update
    status = self.client.mgmt_status()
  File "/usr/lib/python3.6/site-packages/alertaclient/api.py", line 276, in mgmt_status
    return self.http.get('/management/status')
  File "/usr/lib/python3.6/site-packages/alertaclient/api.py", line 324, in get
    return self._handle_error(response)
  File "/usr/lib/python3.6/site-packages/alertaclient/api.py", line 356, in _handle_error
    resp = response.json()
  File "/usr/lib/python3.6/site-packages/requests/models.py", line 892, in json
    return complexjson.loads(self.text, **kwargs)
  File "/usr/lib64/python3.6/json/__init__.py", line 354, in loads
    return _default_decoder.decode(s)
  File "/usr/lib64/python3.6/json/decoder.py", line 339, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "/usr/lib64/python3.6/json/decoder.py", line 357, in raw_decode
    raise JSONDecodeError("Expecting value", s, err.value) from None
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

ps ax | grep /alerta
12553 pts/0    S      0:00 /usr/bin/python3 /usr/bin/alertad run

Publish docs to GitHub Pages

To speed up and simplify the build and deploy process move the hosting of https://docs.alerta.io from ReadTheDocs to GitHub Pages.

alerta server install error

after running "alertad" command following error comes

 File "/usr/local/bin/alertad", line 5, in <module>
    from pkg_resources import load_entry_point
  File "/usr/lib/python2.7/dist-packages/pkg_resources.py", line 2749, in <module>
    working_set = WorkingSet._build_master()
  File "/usr/lib/python2.7/dist-packages/pkg_resources.py", line 446, in _build_master
    return cls._build_from_requirements(__requires__)
  File "/usr/lib/python2.7/dist-packages/pkg_resources.py", line 459, in _build_from_requirements
    dists = ws.resolve(reqs, Environment())
  File "/usr/lib/python2.7/dist-packages/pkg_resources.py", line 628, in resolve
    raise DistributionNotFound(req)
pkg_resources.DistributionNotFound: oauthlib>=0.6.2

Heartbeats documentation missing/old

Issue Summary

Documentation regarding heartbeats describes setting environment etc with tags, but this doesn't work in reality. API documentation isn't updated as well regarding this, seems.

$ alerta heartbeat --origin test -T environment:production --timeout 60
ERROR: Do not use tags for "environment" or "group". See help.

https://docs.alerta.io/en/latest/cli.html#heartbeat-send-a-heartbeat
https://docs.alerta.io/en/latest/api/heartbeat.html
https://docs.alerta.io/en/latest/api/reference.html#heartbeats

The documentation also doesn't describe how latency is calculated and used.

Environment

$ alerta version
alerta 7.4.5
alerta client 7.4.4
requests 2.23.0
click 7.1.1

Document default "reject" plugin settings

@strzelecki-maciek

hi guys, i have a problem with 403 when alertmanager tries to post an alert to Alerta. I have an apikey, created it as admin use, key is read/write, named prometheus. The counter shows it was used "960 times" so far, and each and every one is 403. What am i missing?
ok, my problem was a missing environment label. this could be made slightly more visible in the docs :)

Documentation update for pingdom webhook

In order to make the pingdom webhooks work, I followed this https://docs.alerta.io/en/latest/integrations.html#id7

The example webhook URL is

Example Pingdom Webhook URL

https://alerta.example.com/api/webhooks/pingdom

But in my case, I had to include the api_key to make it work https://alerta.example.com/api/webhooks/pingdom?api-key=xxxxxxx

I think the doc needs more details, either adding that info here or explaining how we can make the auth work with the URL provided.

I can PR any doc repo to update.

See alerta/python-alerta-client#50

[docs] Add result chaining and attribute & tag update to Plugins tutorial

See alerta/alerta#377

alerta / alerta-docs Goto Github PK

alerta-docs's Introduction

Alerta Docs

Dependencies

References

License

alerta-docs's People

Contributors

Stargazers

Watchers

Forkers

alerta-docs's Issues

Recommend Projects

Recommend Topics

Recommend Org