Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/development/code_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ RabbitMQ for incoming executions.

Notifier and results tracker are also part of this code base. Notifier is the component that
sends notification triggers and action triggers at the end of action execution. Results tracker
is an advanced async results querier for certain kind of runners like Mistral, where execution of
a workflow is kicked off remotely and you have to poll the Mistral APIs to collect results.
is an advanced async results querier for certain kind of runners like 3rd party integrations, where
execution of an action is kicked off and you have to poll the integrations APIs to collect results.

st2client
---------
Expand Down
8 changes: 0 additions & 8 deletions docs/source/development/sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,6 @@ Fedora
systemctl enable rabbitmq-server
systemctl restart rabbitmq-server

Optional Requirements
~~~~~~~~~~~~~~~~~~~~~

Mistral
-------
Mistral workflow engine also has its own requirements. For more information, please refer to the
:github_mistral:`Mistral README <README.rst>`.

Project Requirements
~~~~~~~~~~~~~~~~~~~~

Expand Down
12 changes: 6 additions & 6 deletions docs/source/reference/metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ or deployment related issues (e.g. long average duration for a particular action
an issue with that action or similar).

Configuring and Enabling Metrics Collection
===========================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::

Expand Down Expand Up @@ -48,7 +48,7 @@ For a full list of config options, see the ``[metrics]`` section in the |st2| sa
config here: https://github.com/StackStorm/st2/blob/master/conf/st2.conf.sample

Configuring StatsD
==================
~~~~~~~~~~~~~~~~~~

|st2| ``statsd`` metrics driver is compatible with any service which exposes statsd compatible
interface for receiving metrics via UDP.
Expand All @@ -66,7 +66,7 @@ you get started with statsd and self hosted graphite and carbon cache instance
can be found at https://github.com/StackStorm/st2/tree/master/conf/metrics.

Exposed Metrics
===============
~~~~~~~~~~~~~~~

.. note::

Expand Down Expand Up @@ -154,7 +154,7 @@ API requests in a particular time frame, you would use ``integral()`` graphite f
``integral(stats.counters.st2.api.requests.count)``).

Example Graphite Dashboard
===========================
~~~~~~~~~~~~~~~~~~~~~~~~~~

Below you can find code for an example Graphite dashboard which contains most of the common graphs
you need to have a good operational visibility into |st2| deployment.
Expand All @@ -171,7 +171,7 @@ during a particular point in time" and "total counts for a particular execution
derived from the raw metric values.

Pushing metrics to InfluxDB
===========================
~~~~~~~~~~~~~~~~~~~~~~~~~~~

It is possible to gather the StatsD data with Telegraf to push them to InfluxDB.
The StatsD data are formatted in a different way than InfluxDB usually, so we can use the template feature that is availabie in the Telegraf StatsD importer to reformat them to something more convenients (with flags, etc..)
Expand All @@ -182,7 +182,7 @@ Configure your InfluxDB and Telegraf InfluxDB output as usual, then on the Stats
:language: toml

Pushing metrics to Prometheus via the statsd_exporter
=====================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Prometheus provides a service called `Statsd Exporter <https://github.com/prometheus/statsd_exporter>`_ which receives data in the StatsD format and acts as a scrape target for Prometheus.

Expand Down
2 changes: 0 additions & 2 deletions docs/source/troubleshooting/__debug_info_config.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
log_file_paths:
- /var/log/st2/*.log
- /var/log/mistral*.log
st2_config_file_path: /etc/st2/st2.conf
mistral_config_file_path: /etc/mistral/mistral.conf
s3_bucket_url: https://st2debuginfo.s3.amazonaws.com/
gpg_key_fingerprint: BDE989A1F308B18D29789C717064B11C82F62D6F
gpg_key : |
Expand Down
4 changes: 1 addition & 3 deletions docs/source/troubleshooting/self_verification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@ To run the |st2| self-verification script:

sudo ST2_AUTH_TOKEN=$(st2 auth st2admin -p '<PASSWORD>' -t) /opt/stackstorm/st2/bin/st2-self-check

By default, ``st2-self-check`` will run Orquesta and Mistral tests, but will **not** run Windows tests. This can be
controlled with CLI options. You can also choose which st2tests branch to use:
By default, ``st2-self-check`` will run Orquesta tests, but will **not** run Windows tests. This can be controlled with CLI options. You can also choose which st2tests branch to use:

.. code-block:: bash

Usage: /usr/bin/st2-self-check

Options:
-o Skip Orquesta tests
-m Skip Mistral tests
-w Run Windows tests
-b Which branch of st2tests to use (defaults to master)
6 changes: 1 addition & 5 deletions docs/source/troubleshooting/submit_debug_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ help us debug or troubleshoot your issue.
By default, this utility sends us the following information:

* All the |st2| services log files from ``/var/log/st2``
* Mistral service log file from ``/var/log/mistral.log``
* |st2| and Mistral config file (``/etc/st2/st2.conf``,
``/etc/mistral/mistral.conf``). Prior to sending the config files we strip
sensitive information such as database and queue access information.
* |st2| config file (``/etc/st2/st2.conf``). Prior to sending the config files we strip sensitive information such as database and queue access information.
* |st2| content (integration packs) minus the pack configs.

All this information is bundled up in a tarball and encrypted using our
Expand Down Expand Up @@ -103,7 +100,6 @@ from a YAML file. The following config options are supported:

* ``log_file_paths`` - an additional set of log files to gather
* ``st2_config_file_path`` - path to st2.conf
* ``mistral_config_file_path`` - path to mistral.conf
* ``s3_bucket_url`` - the S3 bucket to upload the archive to
* ``gpg_key_fingerprint`` - gpg fingerprint to use when encrypting the archive
* ``gpg_key`` - gpg key to use when encrypting the archive
Expand Down