appenlight Commit - r53:4c889c0f · RhodeCode Free Hosting

documentation: all the documentation for AE

ergo -

r53:4c889c0f

parent child

docs/Appenlight-docs/Makefile

0 created 644 +172 0

@@ -0,0 +1,172 b''
	1	# Makefile for Sphinx documentation
	2	#
	3
	4	# You can set these variables from the command line.
	5	SPHINXOPTS = -W
	6	SPHINXBUILD = ../result/bin/sphinx-build
	7	PAPER =
	8	BUILDDIR = _build
	9
	10	# Internal variables.
	11	PAPEROPT_a4 = -D latex_paper_size=a4
	12	PAPEROPT_letter = -D latex_paper_size=letter
	13	ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
	14	# the i18n builder cannot share the environment and doctrees with the others
	15	I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
	16
	17	.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
	18
	19	help:
	20	@echo "Please use \`make <target>' where <target> is one of"
	21	@echo " html to make standalone HTML files"
	22	@echo " dirhtml to make HTML files named index.html in directories"
	23	@echo " singlehtml to make a single large HTML file"
	24	@echo " pickle to make pickle files"
	25	@echo " json to make JSON files"
	26	@echo " htmlhelp to make HTML files and a HTML help project"
	27	@echo " qthelp to make HTML files and a qthelp project"
	28	@echo " devhelp to make HTML files and a Devhelp project"
	29	@echo " epub to make an epub"
	30	@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	31	@echo " latexpdf to make LaTeX files and run them through pdflatex"
	32	@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
	33	@echo " text to make text files"
	34	@echo " man to make manual pages"
	35	@echo " texinfo to make Texinfo files"
	36	@echo " info to make Texinfo files and run them through makeinfo"
	37	@echo " gettext to make PO message catalogs"
	38	@echo " changes to make an overview of all changed/added/deprecated items"
	39	@echo " xml to make Docutils-native XML files"
	40	@echo " pseudoxml to make pseudoxml-XML files for display purposes"
	41	@echo " linkcheck to check all external links for integrity"
	42	@echo " doctest to run all doctests embedded in the documentation (if enabled)"
	43
	44	clean:
	45	rm -rf $(BUILDDIR)
	46
	47	html:
	48	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	49	@echo
	50	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
	51
	52	dirhtml:
	53	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
	54	@echo
	55	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
	56
	57	singlehtml:
	58	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
	59	@echo
	60	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
	61
	62	pickle:
	63	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
	64	@echo
	65	@echo "Build finished; now you can process the pickle files."
	66
	67	json:
	68	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
	69	@echo
	70	@echo "Build finished; now you can process the JSON files."
	71
	72	htmlhelp:
	73	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
	74	@echo
	75	@echo "Build finished; now you can run HTML Help Workshop with the" \
	76	".hhp project file in $(BUILDDIR)/htmlhelp."
	77
	78	qthelp:
	79	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
	80	@echo
	81	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
	82	".qhcp project file in $(BUILDDIR)/qthelp, like this:"
	83	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RhodeCodeInstaller.qhcp"
	84	@echo "To view the help file:"
	85	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RhodeCodeInstaller.qhc"
	86
	87	devhelp:
	88	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
	89	@echo
	90	@echo "Build finished."
	91	@echo "To view the help file:"
	92	@echo "# mkdir -p $$HOME/.local/share/devhelp/RhodeCodeInstaller"
	93	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RhodeCodeInstaller"
	94	@echo "# devhelp"
	95
	96	epub:
	97	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
	98	@echo
	99	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
	100
	101	latex:
	102	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	103	@echo
	104	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
	105	@echo "Run \`make' in that directory to run these through (pdf)latex" \
	106	"(use \`make latexpdf' here to do that automatically)."
	107
	108	latexpdf:
	109	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	110	@echo "Running LaTeX files through pdflatex..."
	111	$(MAKE) -C $(BUILDDIR)/latex all-pdf
	112	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
	113
	114	latexpdfja:
	115	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
	116	@echo "Running LaTeX files through platex and dvipdfmx..."
	117	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
	118	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
	119
	120	text:
	121	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
	122	@echo
	123	@echo "Build finished. The text files are in $(BUILDDIR)/text."
	124
	125	man:
	126	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
	127	@echo
	128	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
	129
	130	texinfo:
	131	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
	132	@echo
	133	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
	134	@echo "Run \`make' in that directory to run these through makeinfo" \
	135	"(use \`make info' here to do that automatically)."
	136
	137	info:
	138	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
	139	@echo "Running Texinfo files through makeinfo..."
	140	make -C $(BUILDDIR)/texinfo info
	141	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
	142
	143	gettext:
	144	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
	145	@echo
	146	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
	147
	148	changes:
	149	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
	150	@echo
	151	@echo "The overview file is in $(BUILDDIR)/changes."
	152
	153	linkcheck:
	154	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
	155	@echo
	156	@echo "Link check complete; look for any errors in the above output " \
	157	"or in $(BUILDDIR)/linkcheck/output.txt."
	158
	159	doctest:
	160	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
	161	@echo "Testing of doctests in the sources finished, look at the " \
	162	"results in $(BUILDDIR)/doctest/output.txt."
	163
	164	xml:
	165	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
	166	@echo
	167	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
	168
	169	pseudoxml:
	170	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
	171	@echo
	172	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/Appenlight-docs/_templates/layout.html

0 created 644 +19 0

@@ -0,0 +1,19 b''
	1	{% extends "!layout.html" %}
	2	{% set css_files = css_files + ['_static/add.css'] %}
	3	{% set css_files = css_files + ['https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css'] %}
	4
	5	{% block footer %}
	6	{{ super() }}
	7
	8	<script>
	9	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){
	10	(i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
	11	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
	12	})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
	13
	14	ga('create', 'UA-55639800-3', 'auto');
	15	ga('send', 'pageview');
	16
	17	</script>
	18
	19	{% endblock %}

docs/Appenlight-docs/admin/admin.rst

0 created 644 +9 0

@@ -0,0 +1,9 b''
	1	Configuration Setup
	2	===================
	3
	4	.. toctree::
	5	:maxdepth: 1
	6
	7	connect-enterprise
	8	alert-channels
	9	auth-tokens

docs/Appenlight-docs/admin/ae-cli.rst

0 created 644 +108 0

@@ -0,0 +1,108 b''
	1	.. _rae-cli:
	2
	3	\|RAE\| CLI Guide
	4	===============
	5
	6	appenlight-cleanup
	7	------------------
	8
	9	.. py:function:: appenlight_cleanup [-c, --config <PATH>] [-t, --types <choices>]
	10	[-r, --resource <resource-id>] [-n, --namespace <resource-id>]
	11
	12	Clean up the \|RAE\| database records.
	13
	14	:argument -c --config: Location of the :file:`appenlight.ini` file.
	15	:argument -t --types: (Optional) Specify the records you want to cleanup in
	16	the database from the following options. The default value is ``logs``.
	17
	18	:argument -r --resource: Specify which application's records you with to
	19	clean up. The <resource-id> refers to your application ID number,
	20	which you can get from the \|RAE\| interface.
	21
	22	:argument -n --namespace: (Optional) Specify which namespace records you
	23	wish to clean up. You can check the available namespace records in
	24	your logs.
	25
	26
	27	.. code-block:: bash
	28
	29	# Clean up logs on resource ID 18
	30	$ ~/python/bin/appenlight_cleanup -c ~/appenlight/production.ini -t logs -r 18
	31
	32	appenlight-initializedb
	33	-----------------------
	34
	35	.. py:function:: appenlight-initializedb <ini-file-name>
	36
	37	Initialize \|RAE\| database.
	38
	39	:argument -c --config: Location of the :file:`appenlight.ini` file.
	40	:argument --username: (Optional) Specify the username of the
	41	new administrator account.
	42	:argument --password: Specify the password of the administrator account.
	43	:argument --email: Specify the email of the administrator account.
	44	:argument --auth-token: Specify the auth token for the administrator.
	45
	46	.. code-block:: bash
	47
	48	# Create a new dev.ini file and database
	49	$ ~/python/bin/appenlight-initializedb -c dev.ini
	50
	51	appenlight-migratedb
	52	--------------------
	53
	54	.. py:function:: appenlight_migratedb <ini-file-name>
	55
	56	Migrate the database associated with the specified :file:`.ini` file.
	57
	58	.. code-block:: bash
	59
	60	# Migrate the specified DB
	61	$ ~/python/bin/appenlight-initializedb -c ~/appenlight/production.ini
	62
	63	appenlight-reindex-elastic-search
	64	---------------------------------
	65
	66	.. py:function:: appenlight_reindex-elastic-search [-c, --config <PATH>] [-t, --types <choices>]
	67
	68	:argument -c --config: Location of the :file:`appenlight.ini` file.
	69	:argument -t --types: (Optional) Specify the records you want to reindex in
	70	the database from the following options. The default value is to
	71	reindex all records.
	72
	73	- ``reports``
	74	- ``logs``
	75	- ``metrics``
	76	- ``slow_calls``
	77	- ``template``
	78	- other types inherited from plugins
	79
	80	.. code-block:: bash
	81
	82	# Reindex reports
	83	$ ~/python/bin/appenlight_reindex_elasticsearch -c ~/appenlight/production.ini -t reports
	84
	85	# Reindex everything
	86	$ ~/python/bin/appenlight_reindex_elasticsearch -c ~/appenlight/production.ini
	87
	88	appenlight-uptime-monitor
	89	-------------------------
	90
	91	.. py:function:: appenlight-uptime-monitor [-c, --config <PATH>] [-s, --sync-url <URL>]
	92	[-u, --update-url <URL>] [-l, --location <ping-id>] [-k, --api-key <api-key>]
	93
	94	\|RAE\| Uptime Monitor.
	95
	96	:argument -c --config: Location of the :file:`appenlight.ini` file.
	97	:argument -s --sync-url: Specify the source URL for monitoring. The
	98	default url is ``http://127.0.0.1:6543/api/uptime_app_list``.
	99	:argument -u --update-url: Specify the destination URL for the uptime
	100	data. The default value is ``http://127.0.0.1:6543/api/uptime``.
	101	:argument -l --location: Integer identifier for location of ping service.
	102	The default location is ``1``.
	103	:argument -k --api-key: The administrator user auth TOKEN.
	104
	105	.. code-block:: bash
	106
	107	# Run uptime monitoring script
	108	$ ~/python/bin/appenlight-uptime-monitor -c uptime_config.ini

docs/Appenlight-docs/admin/alert-channels.rst

0 created 644 +52 0

@@ -0,0 +1,52 b''
	1	Alert Channels
	2	==============
	3
	4	You can configure \|RAE\| to send alerts to multiple channels.
	5
	6	Email Channel
	7	-------------
	8
	9	To configure an email alert channel and the rules criteria, use the following
	10	steps:
	11
	12	1. Select :menuselection:`Settings --> Add Email Channel`
	13	2. Add your email address.
	14	3. On the :guilabel:`Alert channels` page, configure the notification rules
	15	based on the following criteria.
	16
	17	.. hlist::
	18
	19	- Application
	20	- HTTP Status
	21	- Request Duration
	22	- Priority
	23	- Domain
	24	- URL Path
	25	- Error
	26	- Tag
	27	- Group
	28
	29	.. image:: ../images/set-alerts.png
	30
	31	Additional Channels
	32	-------------------
	33
	34	You can configure further channels using the following steps:
	35
	36	1. Select :menuselection:`Settings --> List Applications`
	37	2. Click :guilabel:`Integrations` beside the application for which you wish to
	38	configure alerts.
	39
	40	The following integrations are available, and you can read more in the
	41	:ref:`integrations` section:
	42
	43	.. hlist::
	44
	45	- Bitbucket
	46	- Campfire
	47	- Flowdock
	48	- github
	49	- Hipchat
	50	- Jira
	51	- Slack
	52	- webhooks

docs/Appenlight-docs/admin/application-monitoring.rst

0 created 644 +48 0

@@ -0,0 +1,48 b''
	1	Application Monitoring
	2	======================
	3
	4	You can connect multiple applications to \|RAE\| for monitoring. To do this,
	5	use the information in this section.
	6
	7	Adding an Application
	8	---------------------
	9
	10	1. Select :menuselection:`Settings --> Create Application`.
	11	2. Set the :guilabel:`Application name` and :guilabel:`Application URL`.
	12	3. Click :guilabel:`Create Application`.
	13
	14	.. note::
	15
	16	You will need to configure your application to communicate with \|RAE\|.
	17	See the instructions for your particular framework in the
	18	`Appenlight Developer Docs`_.
	19
	20	Transfer Application Ownership
	21	------------------------------
	22
	23	1. Select :menuselection:`Admin --> List Applications --> Settings`
	24	2. In the :guilabel:`Transfer Ownership` section, enter the following
	25	details:
	26
	27	- The current owner's password
	28	- The new owner's username
	29
	30	3. Click :guilabel:`Transfer Ownership of application`
	31
	32	Adding Users and User Groups
	33	----------------------------
	34
	35	Access to each application is granted on a :guilabel:`User Group` or
	36	:guilabel:`User` basis, see the :ref:`user-perms` section for more details.
	37
	38	Removing an Application
	39	-----------------------
	40
	41	To remove an application from \|RAE\|, us the following steps.
	42
	43	1. Select :menuselection:`Admin --> List Applications`
	44	2. Click :guilabel:`Settings` beside the application you want to delete.
	45	3. Click :guilabel:`Delete my application`
	46
	47
	48	.. _Appenlight Developer Docs: https://appenlight.rhodecode.com/page/api/main

docs/Appenlight-docs/admin/auth-tokens.rst

0 created 644 +16 0

@@ -0,0 +1,16 b''
	1	Authentication Tokens
	2	=====================
	3
	4	These tokens are used to authenticate users when accessing information using
	5	the API.
	6
	7	Creating Tokens
	8	---------------
	9
	10	To create Authentication Tokens, go to the
	11	:menuselection:`Settings --> Auth Tokens` page.
	12
	13	.. note::
	14
	15	The API is currently in BETA, so there is no real need to use
	16	Authentication Tokens yet.

docs/Appenlight-docs/admin/connect-enterprise.rst

0 created 644 +100 0

@@ -0,0 +1,100 b''
	1	.. _connect-enterprise:
	2
	3	How To Use \|AE\| to Monitor \|RCE\|
	4	================================
	5
	6	.. raw:: html
	7
	8	From the landing page, the <i class="fa fa-cog "></i> icon takes you to
	9	the settings page.<br><br>
	10
	11	1. From the interface, create an application for \|AE\| to monitor:
	12	:menuselection:`Settings --> Create Application`
	13	2. Add in your \|RCE\| instance details.
	14	3. Take note of the Public and Private API keys on the application page. You
	15	will need to add the private key to your \|RCE\| configuration file.
	16
	17	\|RCE\| Side Of The Setup
	18	-----------------------
	19
	20	Once you have your \|AE\| account details, configure the \|RCE\|
	21	:file:`home/{user}/.rccontrol/{instance-id}/rhodecode.ini` file with the
	22	following details to set up the connection between the two systems.
	23
	24	.. tip::
	25
	26	The section below should already be present in your configuration file if
	27	running a recent version of \|RCE\|.
	28
	29	* Enable the \|AE\| connection by setting ``appenlight = true``.
	30	* Set your \|AE\| URL using the ``appenlight.server_url = URL`` option.
	31	* Set your \|AE\| \|authtoken\| using the ``appenlight.api_key = TOKEN`` option.
	32
	33	.. code-block:: ini
	34	:emphasize-lines: 10,12,13
	35
	36	###################################
	37	## ERROR AND LOG HANDLING SYSTEM ##
	38	###################################
	39
	40	## Appenlight is tailored to work with RhodeCode, see
	41	## http://appenlight.com for details how to obtain an account
	42	## you must install python package `appenlight_client` to make it work
	43
	44	## appenlight enabled
	45	appenlight = false
	46
	47	appenlight.server_url = https://api.appenlight.com
	48	appenlight.api_key = YOUR_PRIVATE_API_KEY
	49
	50	## TWEAK AMOUNT OF INFO SENT HERE
	51
	52	## enables 404 error logging (default False)
	53	appenlight.report_404 = false
	54
	55	## time in seconds after request is considered being slow (default 1)
	56	appenlight.slow_request_time = 1
	57
	58	## record slow requests in application
	59	## (needs to be enabled for slow datastore recording and time tracking)
	60	appenlight.slow_requests = true
	61
	62	## enable hooking to application loggers
	63	appenlight.logging = true
	64
	65	## minimum log level for log capture
	66	appenlight.logging.level = WARNING
	67
	68	## send logs only from erroneous/slow requests
	69	## (saves API quota for intensive logging)
	70	appenlight.logging_on_error = false
	71
	72	## list of additonal keywords that should be grabbed from environ object
	73	## can be string with comma separated list of words in lowercase
	74	## (by default client will always send following info:
	75	## 'REMOTE_USER', 'REMOTE_ADDR', 'SERVER_NAME', 'CONTENT_TYPE' + all keys that
	76	## start with HTTP* this list be extended with additional keywords here
	77	appenlight.environ_keys_whitelist = ""
	78
	79	## list of keywords that should be blanked from request object
	80	## can be string with comma separated list of words in lowercase
	81	## (by default client will always blank keys that contain following words
	82	## 'password', 'passwd', 'pwd', 'auth_tkt', 'secret', 'csrf'
	83	## this list be extended with additional keywords set here
	84	appenlight.request_keys_blacklist = ""
	85
	86	## list of namespaces that should be ignores when gathering log entries
	87	## can be string with comma separated list of namespaces
	88	## (by default the client ignores own entries: appenlight_client.client)
	89	appenlight.log_namespace_blacklist = ""
	90
	91	Verifying The Setup
	92	-------------------
	93
	94	Once \|RCE\| and \|AE\| are working together you will see the monitoring begin on
	95	your \|AE\| dashboard when you start carrying out actions in \|RCE\|.
	96
	97	.. image:: ../images/ae-verify.png
	98
	99	.. _sign up for an account: https://appenlight.rhodecode.com/
	100	.. _here: https://appenlight.rhodecode.com/page/api/main

docs/Appenlight-docs/admin/overview.rst

0 created 644 +64 0

@@ -0,0 +1,64 b''
	1	.. _feature-overview:
	2
	3	Feature Overview
	4	================
	5
	6	Error Reporting
	7	---------------
	8
	9	- Reports are grouped based on parameters such as server, exception, or
	10	view name.
	11	- Every report contains the stacktrace that generated it, and you can inspect
	12	local frame variables from each stacktrace.
	13	- It is possible to attach custom context data to reports.
	14	- Separate occurrences of an error within a group can be inspected.
	15	- Exception trends can be spotted by using the graphing features and
	16	visualising the data.
	17	- You can see application logs that happen during a specific request.
	18	- You can identify slow calls and get a layered breakdown of request executions.
	19	- You can access all request parameters in exception reports.
	20	- Full-text search reports are available based on filters.
	21	- You can set prioritization rules for your reports.
	22	- You can set report alerts to notify someone immediately if a particular
	23	problem occurs.
	24
	25
	26	Performance Monitoring
	27	----------------------
	28
	29	- Automatic application performance monitoring once your system is connected
	30	to \|RAE\|.
	31	- Slow request are monitored with individual query details, and slow call
	32	details can be viewed from the interface.
	33	- You can view your application performance metrics and response time
	34	statistics using filters to breakdown the data.
	35	- You can get insights into different layers of your application including: SQL
	36	queries, time traces, noSql data stores, cache layers, remote connection
	37	times, and others.
	38	- You can get a breakdown of the most accessed view in your application, and
	39	their average response times.
	40	- You can connect multiple servers to the system and filter data base on the
	41	hostname.
	42	- You can trace the performance of your own functions.
	43	- You can use full-text search to get reports based on server, priority,
	44	occurrences, average duration, url path, namespace and others.
	45	- You can set prioritization rules for your reports.
	46
	47	In-app Logging
	48	--------------
	49
	50	- You can view external and in-app logs separately.
	51	- Once connected your application will start streaming logs that you can then
	52	use to generate reports.
	53	- You can filter logs based on server, severity, log contents or
	54	namespace.
	55	- You can see logs that are being generated by specific requests.
	56
	57	Collaboration Features
	58	----------------------
	59
	60	- You can add many users to your \|RAE\| instance.
	61	- You can set read/write permissions to team members on a
	62	per-connected-application basis.
	63	- You can assign reports to team members for review.
	64	- You can leave comments on reports.

docs/Appenlight-docs/admin/system-architecture.rst

0 created 644 +4 0

@@ -0,0 +1,4 b''
	1	\|RAE\| Architecture
	2	==================
	3
	4	Fill in later

docs/Appenlight-docs/admin/user-admin.rst

0 created 644 +56 0

@@ -0,0 +1,56 b''
	1	.. _user-perms:
	2
	3	User Administration
	4	===================
	5
	6	.. raw:: html
	7
	8	From the landing page, them <i class="fa fa-wrench "></i> icon takes you
	9	to the admin panel. User management is carried out using the following:
	10	<br><br>
	11
	12	- User Groups
	13	- Users
	14
	15	.. image:: ../images/user-mgmt.png
	16
	17	Create A User Group
	18	-------------------
	19
	20	1. Select :menuselection:`Admin --> Create Group`
	21	2. Set the :guilabel:`Group Name` and :guilabel:`Description`
	22	3. Click :guilabel:`Add Group`
	23
	24	Add/Remove Users From Group
	25	---------------------------
	26
	27	1. Select :menuselection:`Admin --> Groups --> Settings`
	28	2. From the :guilabel:`User List` pane, add or remove users.
	29
	30	Create/Edit A User
	31	------------------
	32
	33	1. Select :menuselection:`Admin --> Create User`
	34	2. Set the following user details:
	35
	36	- :guilabel:`Username`
	37	- :guilabel:`Password`
	38	- :guilabel:`Email Address`
	39
	40	3. Click :guilabel:`Add Group`
	41
	42	Setting Permissions
	43	-------------------
	44
	45	Permissions are set for User Groups and Users on a per application basis. To
	46	set their permissions to each one, use the following steps:
	47
	48	1. Select :menuselection:`Admin --> List Applications`
	49	2. Click the :guilabel:`Settings` button beside the application of your choice.
	50	3. From the :guilabel:`Permissions` panel, give the User Group or User access
	51	to the application, and set their level of access from the following options:
	52
	53	- :guilabel:`View`
	54	- :guilabel:`Update Reports`
	55
	56	4. Click :guilabel:`Give permission`

docs/Appenlight-docs/common.py

0 created 644 +33 0

@@ -0,0 +1,33 b''
	1	# Try and keep this list alphabetical
	2	# ui is for user interface elements and messages
	3	# button - that's obvious
	4
	5	rst_epilog = '''
	6	.. \|AE\| replace:: Appenlight
	7	.. \|RAE\| replace:: RhodeCode Appenlight
	8	.. \|authtoken\| replace:: Authentication Token
	9	.. \|authtokens\| replace:: Auth Tokens
	10	.. \|git\| replace:: Git
	11	.. \|hg\| replace:: Mercurial
	12	.. \|svn\| replace:: Subversion
	13	.. \|LDAP\| replace:: LDAP / Active Directory
	14	.. \|os\| replace:: operating system
	15	.. \|OS\| replace:: Operating System
	16	.. \|PY\| replace:: Python
	17	.. \|pr\| replace:: pull request
	18	.. \|prs\| replace:: pull requests
	19	.. \|psf\| replace:: Python Software Foundation
	20	.. \|repo\| replace:: repository
	21	.. \|repos\| replace:: repositories
	22	.. \|RCI\| replace:: RhodeCode Control
	23	.. \|RCC\| replace:: RhodeCode Control
	24	.. \|RCV\| replace:: RhodeCode Enterprise
	25	.. \|RCM\| replace:: RhodeCode Enterprise
	26	.. \|RCE\| replace:: RhodeCode Enterprise
	27	.. \|RCX\| replace:: RhodeCode Extensions
	28	.. \|RCT\| replace:: RhodeCode Tools
	29	.. \|RCEBOLD\| replace:: RhodeCode Enterprise
	30	.. \|RCEITALICS\| replace:: `RhodeCode Enterprise`
	31	.. \|RC\| replace:: RhodeCode
	32	.. \|RNS\| replace:: Release Notes
	33	'''

docs/Appenlight-docs/conf.py

0 created 644 +307 0

@@ -0,0 +1,307 b''
	1	# -- coding: utf-8 --
	2	#
	3	# RhodeCode Enterprise documentation build configuration file, created by
	4	# sphinx-quickstart on Tue Nov 4 11:48:37 2014.
	5	#
	6	# This file is execfile()d with the current directory set to its
	7	# containing dir.
	8	#
	9	# Note that not all possible configuration values are present in this
	10	# autogenerated file.
	11	#
	12	# All configuration values have a default; values that are commented out
	13	# serve to show the default.
	14
	15	import sys
	16	import os
	17	import datetime
	18	import sphinx_rtd_theme
	19
	20	# If extensions (or modules to document with autodoc) are in another directory,
	21	# add these directories to sys.path here. If the directory is relative to the
	22	# documentation root, use os.path.abspath to make it absolute, like shown here.
	23	sys.path.insert(0, os.path.abspath('.'))
	24	import common
	25
	26	# -- General configuration ------------------------------------------------
	27
	28	# If your documentation needs a minimal Sphinx version, state it here.
	29	#needs_sphinx = '1.0'
	30
	31	# Add any Sphinx extension module names here, as strings. They can be
	32	# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
	33	# ones.
	34	extensions = [
	35	'sphinx.ext.intersphinx',
	36	'sphinx.ext.todo',
	37	'sphinx.ext.pngmath'
	38	]
	39
	40	intersphinx_mapping = {
	41	'enterprise': ('https://docs.rhodecode.com/RhodeCode-Enterprise/', None),
	42	'control': ('https://docs.rhodecode.com/RhodeCode-Control/', None),
	43	}
	44
	45	if tags.has('dev'):
	46	intersphinx_mapping.update({
	47	'enterprise': ('https://ci.rhodecode.com/documentation/Momentum/', None),
	48	'control': ('https://ci.rhodecode.com/documentation/Control/', None),
	49	})
	50
	51
	52	# Add any paths that contain templates here, relative to this directory.
	53	templates_path = ['_templates']
	54
	55	# The suffix of source filenames.
	56	source_suffix = '.rst'
	57
	58	# The encoding of source files.
	59	#source_encoding = 'utf-8-sig'
	60
	61	# The master toctree document.
	62	master_doc = 'index'
	63
	64	# The version info for the project you're documenting, acts as replacement for
	65	# \|version\| and \|release\|, also used in various other places throughout the
	66	# built documents.
	67
	68	# TODO: johbo: Move into common package for documentation utilities
	69	def _get_version():
	70	with open('../VERSION') as f:
	71	return f.read().strip()
	72
	73	# The full version, including alpha/beta/rc tags.
	74	release = _get_version()
	75	# The short X.Y version.
	76	version = '.'.join(release.split('.', 2)[:2]) # First two parts of release
	77
	78	# General information about the project.
	79	project = u'RhodeCode Appenlight %s ' % _get_version()
	80	copyright = u'2014-{now.year}, RhodeCode GmbH'.format(
	81	now=datetime.datetime.today())
	82
	83
	84	# The language for content autogenerated by Sphinx. Refer to documentation
	85	# for a list of supported languages.
	86	#language = None
	87
	88	rst_epilog = common.rst_epilog + """
	89	.. \|async\| replace:: asynchronous
	90	"""
	91
	92	# There are two options for replacing \|today\|: either, you set today to some
	93	# non-false value, then it is used:
	94	#today = ''
	95	# Else, today_fmt is used as the format for a strftime call.
	96	#today_fmt = '%B %d, %Y'
	97
	98	# List of patterns, relative to source directory, that match files and
	99	# directories to ignore when looking for source files.
	100	exclude_patterns = [
	101	# Special directories
	102	'_build',
	103	'result',
	104
	105	# Other RST files
	106	'install/install.rst',
	107	'admin/system-architecture.rst',
	108	'logs/logs.rst',
	109
	110	]
	111
	112
	113	# The reST default role (used for this markup: `text`) to use for all
	114	# documents.
	115	#default_role = None
	116
	117	# If true, '()' will be appended to :func: etc. cross-reference text.
	118	#add_function_parentheses = True
	119
	120	# If true, the current module name will be prepended to all description
	121	# unit titles (such as .. function::).
	122	#add_module_names = True
	123
	124	# If true, sectionauthor and moduleauthor directives will be shown in the
	125	# output. They are ignored by default.
	126	#show_authors = False
	127
	128	# The name of the Pygments (syntax highlighting) style to use.
	129	pygments_style = 'sphinx'
	130
	131	# A list of ignored prefixes for module index sorting.
	132	#modindex_common_prefix = []
	133
	134	# If true, keep warnings as "system message" paragraphs in the built documents.
	135	keep_warnings = tags.has("dev")
	136
	137
	138	# -- Options for HTML output ----------------------------------------------
	139
	140	# The theme to use for HTML and HTML Help pages. See the documentation for
	141	# a list of builtin themes.
	142	#html_theme = 'rctheme'
	143	html_theme = 'sphinx_rtd_theme'
	144
	145	# Theme options are theme-specific and customize the look and feel of a theme
	146	# further. For a list of options available for each theme, see the
	147	# documentation.
	148	#html_theme_options = {}
	149	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
	150
	151	# Add any paths that contain custom themes here, relative to this directory.
	152	#html_theme_path = []
	153
	154	# The name for this set of Sphinx documents. If None, it defaults to
	155	# "<project> v<release> documentation".
	156	#html_title = None
	157
	158	# A shorter title for the navigation bar. Default is the same as html_title.
	159	#html_short_title = None
	160
	161	# The name of an image file (relative to this directory) to place at the top
	162	# of the sidebar.
	163	#html_logo = None
	164	html_sidebars = {
	165	'**': ['globaltoc.html'],
	166	}
	167
	168	# The name of an image file (within the static path) to use as favicon of the
	169	# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
	170	# pixels large.
	171	html_favicon = 'images/favicon.ico'
	172
	173	# Add any paths that contain custom static files (such as style sheets) here,
	174	# relative to this directory. They are copied after the builtin static files,
	175	# so a file named "default.css" will overwrite the builtin "default.css".
	176	html_static_path = ['static/css/add.css']
	177
	178	# Add any extra paths that contain custom files (such as robots.txt or
	179	# .htaccess) here, relative to this directory. These files are copied
	180	# directly to the root of the documentation.
	181	#html_extra_path = []
	182
	183	# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
	184	# using the given strftime format.
	185	#html_last_updated_fmt = '%b %d, %Y'
	186
	187	# If true, SmartyPants will be used to convert quotes and dashes to
	188	# typographically correct entities.
	189	#html_use_smartypants = True
	190
	191	# Custom sidebar templates, maps document names to template names.
	192	#html_sidebars = {}
	193
	194	# Additional templates that should be rendered to pages, maps page names to
	195	# template names.
	196	#html_additional_pages = {}
	197
	198	# If false, no module index is generated.
	199	#html_domain_indices = True
	200
	201	# If false, no index is generated.
	202	#html_use_index = True
	203
	204	# If true, the index is split into individual pages for each letter.
	205	#html_split_index = False
	206
	207	# If true, links to the reST sources are added to the pages.
	208	#html_show_sourcelink = True
	209
	210	# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
	211	#html_show_sphinx = True
	212
	213	# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
	214	#html_show_copyright = True
	215
	216	# If true, an OpenSearch description file will be output, and all pages will
	217	# contain a <link> tag referring to it. The value of this option must be the
	218	# base URL from which the finished HTML is served.
	219	#html_use_opensearch = ''
	220
	221	# This is the file name suffix for HTML files (e.g. ".xhtml").
	222	#html_file_suffix = None
	223
	224	# Output file base name for HTML help builder.
	225	htmlhelp_basename = 'rhodecode-appenlight'
	226
	227
	228	# -- Options for LaTeX output ---------------------------------------------
	229
	230	latex_elements = {
	231	# The paper size ('letterpaper' or 'a4paper').
	232	#'papersize': 'letterpaper',
	233
	234	# The font size ('10pt', '11pt' or '12pt').
	235	#'pointsize': '10pt',
	236
	237	# Additional stuff for the LaTeX preamble.
	238	#'preamble': '',
	239	}
	240
	241	# Grouping the document tree into LaTeX files. List of tuples
	242	# (source start file, target name, title,
	243	# author, documentclass [howto, manual, or own class]).
	244	latex_documents = [
	245	('index', 'RhodeCodeAppenlight.tex', u'RhodeCode Appenlight',
	246	u'RhodeCode GmbH', 'manual'),
	247	]
	248
	249	# The name of an image file (relative to this directory) to place at the top of
	250	# the title page.
	251	#latex_logo = None
	252
	253	# For "manual" documents, if this is true, then toplevel headings are parts,
	254	# not chapters.
	255	#latex_use_parts = False
	256
	257	# If true, show page references after internal links.
	258	#latex_show_pagerefs = False
	259
	260	# If true, show URL addresses after external links.
	261	#latex_show_urls = False
	262
	263	# Documents to append as an appendix to all manuals.
	264	#latex_appendices = []
	265
	266	# If false, no module index is generated.
	267	#latex_domain_indices = True
	268
	269
	270	# -- Options for manual page output ---------------------------------------
	271
	272	# One entry per manual page. List of tuples
	273	# (source start file, name, description, authors, manual section).
	274	man_pages = [
	275	('rhodecode-enterprise', 'rhodecodeenterprise', u'RhodeCode Enterprise',
	276	[u'RhodeCode GmbH'], 1)
	277	]
	278
	279	# If true, show URL addresses after external links.
	280	#man_show_urls = False
	281
	282
	283	# -- Options for Texinfo output -------------------------------------------
	284
	285	# Grouping the document tree into Texinfo files. List of tuples
	286	# (source start file, target name, title, author,
	287	# dir menu entry, description, category)
	288	texinfo_documents = [
	289	('rhodecode-enterprise', 'RhodeCodeEnterprise', u'RhodeCode Enterprise',
	290	u'Brian Butler', 'RhodeCodeEnterprise', 'One line description of project.',
	291	'Miscellaneous'),
	292	]
	293
	294	# Documents to append as an appendix to all manuals.
	295	#texinfo_appendices = []
	296
	297	# If false, no module index is generated.
	298	#texinfo_domain_indices = True
	299
	300	# How to display URL addresses: 'footnote', 'no', or 'inline'.
	301	#texinfo_show_urls = 'footnote'
	302
	303	# If true, do not generate a @detailmenu in the "Top" node's menu.
	304	#texinfo_no_detailmenu = False
	305
	306	# We want to see todo notes in case of a pre-release build of the documentation
	307	todo_include_todos = True

docs/Appenlight-docs/graphs/creating-dashboards.rst

0 created 644 +37 0

@@ -0,0 +1,37 b''
	1	Creating Custom Dashboards
	2	==========================
	3
	4	.. important::
	5
	6	To generate custom dashboards you need to use the \|RAE\|
	7	`Logging API`_ to export the data you want to chart. See the example
	8	scripts for doing this in the :ref:`log-script-eg` section.
	9
	10	To create a custom dashboard, use the following steps.
	11
	12	1. From the \|RAE\| home page, select
	13	:menuselection:`Charts --> Custom Dashboards --> Create Dashboard`
	14	2. Add a name in the :guilabel:`Dashboard title` files and save the chart.
	15	Then you can click on the :guilabel:`Configure Chart` button to
	16	start creating it.
	17	3. Configure the following basic chart settings:
	18
	19	- The :guilabel:`Application` from which the data is being monitored.
	20	- Select the :guilabel:`Chart Type`.
	21	- Choose between a :guilabel:`Timeseries histogram` or a :guilabel:`Terms`
	22	based chart.
	23	- Select the :guilabel:`Aggregation type` from the drop down menu
	24
	25	4. From here on, it depends on what data is being used. In the following
	26	example, this is being calculated:
	27
	28	- the sum of sales in which the quantity of items sold was over 50
	29	- for product_name 37
	30	- over the last 7 days
	31
	32	.. image:: ../images/custom-dashboard.png
	33	:alt: Custom Dashboard Setup
	34
	35	.. _Logging API: https://appenlight.rhodecode.com/page/api/0.5/logs
	36
	37

docs/Appenlight-docs/graphs/export-scripts.rst

0 created 644 +25 0

@@ -0,0 +1,25 b''
	1	.. _log-script-eg:
	2
	3	Logging API Script Examples
	4	===========================
	5
	6	To export data from your application to use with the custom dashboard feature,
	7	use the following examples to create your export scripts. Once exported to
	8	\|RAE\|, the data will be available to begin creating custom charts.
	9
	10	.. tip::
	11
	12	To keep your charts up to date, you could run your export script as a cron
	13	job.
	14
	15	Example Script 1
	16	----------------
	17
	18	.. literalinclude:: test_data_for_analytics_sales.py
	19	:language: python
	20
	21	Example Script 2
	22	----------------
	23
	24	.. literalinclude:: test_data_for_analytics_tickets.py
	25	:language: python

docs/Appenlight-docs/graphs/graphs.rst

0 created 644 +11 0

@@ -0,0 +1,11 b''
	1	Dashboards
	2	==========
	3
	4	.. toctree::
	5	:maxdepth: 1
	6
	7	overview
	8	creating-dashboards
	9	export-scripts
	10
	11

docs/Appenlight-docs/graphs/overview.rst

0 created 644 +9 0

@@ -0,0 +1,9 b''
	1	Dashboard Overview
	2	==================
	3
	4	\|RAE\| comes with a default dashboard and will populate the fields based on
	5	the data it gathers from the connected applications.
	6
	7	.. image:: ../images/default-dashboard.png
	8	:alt: Appenlight Default Dashboard
	9

docs/Appenlight-docs/graphs/test_data_for_analytics_sales.py

0 created 644 +41 0

@@ -0,0 +1,41 b''
	1	import requests
	2	import json
	3	import random
	4
	5	from datetime import datetime, timedelta
	6
	7	endpoint = 'https://api.appenlight.com/api/logs?protocol_version=0.5'
	8	endpoint = 'http://127.0.0.1:6543/api/logs?protocol_version=0.5'
	9
	10
	11	logs = []
	12
	13	date = datetime.utcnow()
	14	for x in xrange(0, 500):
	15	price = random.randint(1, 10)
	16	quantity = random.randint(1, 15)
	17	date = date - timedelta(hours=random.randint(1, 8))
	18	logs.append(
	19	{"log_level": "INFO",
	20	"message": "shop operation",
	21	"timestamp": "",
	22	"date": (date - timedelta(days=x)).strftime('%Y-%m-%dT%H:%M:%S.0'),
	23	"namespace": "rc.shop.dummy_data",
	24	"server": "dummy.server.com",
	25	# "primary_key": x,
	26	"permanent": True,
	27	"tags": [["action", 'buy'],
	28	["product", 'product_name %s' % price],
	29	["price", price],
	30	["quantity", quantity],
	31	["total_payment", price * quantity],
	32	]
	33	}
	34	)
	35
	36	resp = requests.post(endpoint, data=json.dumps(logs), headers={
	37	"Content-Type": "application/json",
	38	"X-appenlight-api-key": "Your.API.Key"
	39	})
	40
	41	print resp.status_code, resp.text

docs/Appenlight-docs/graphs/test_data_for_analytics_tickets.py

0 created 644 +42 0

@@ -0,0 +1,42 b''
	1	import requests
	2	import json
	3	import random
	4
	5	from datetime import datetime, timedelta
	6
	7	endpoint = 'https://api.appenlight.com/api/logs?protocol_version=0.5'
	8	endpoint = 'http://127.0.0.1:6543/api/logs?protocol_version=0.5'
	9
	10
	11	logs = []
	12
	13	date = datetime.utcnow()
	14	for x in xrange(0, 500):
	15	price = random.randint(1, 10)
	16	quantity = random.randint(1, 15)
	17	date = date - timedelta(hours=random.randint(1, 8))
	18	logs.append(
	19	{"log_level": "INFO",
	20	"message": "support ticket",
	21	"timestamp": "",
	22	"date": (date - timedelta(days=x)).strftime('%Y-%m-%dT%H:%M:%S.0'),
	23	"namespace": "rc.support_tickets",
	24	"server": "dummy2.server.com",
	25	"permanent": True,
	26	# "primary_key": x,
	27	"tags": [
	28	["product", 'product_name %s' % price],
	29	["status",
	30	random.choice(['open', 'closed', 'pending', 'invalid'])],
	31	['owner',
	32	random.choice(['brian', 'lisa', 'martin', 'karen', 'sarah'])]
	33	]
	34	}
	35	)
	36
	37	resp = requests.post(endpoint, data=json.dumps(logs), headers={
	38	"Content-Type": "application/json",
	39	"X-appenlight-api-key": "Your.API.Key"
	40	})
	41
	42	print resp.status_code, resp.text

docs/Appenlight-docs/images/ae-logs.png

0 created 644 binary 0 0