This is an automated email from the ASF dual-hosted git repository.
poorejc pushed a commit to branch FLAGON-469
in repository https://gitbox.apache.org/repos/asf/incubator-flagon-useralejs.git
The following commit(s) were added to refs/heads/FLAGON-469 by this push:
new 82effda [FLAGON-481] added pointers to Apache Flagon stack repo in
readme
82effda is described below
commit 82effda57c5ece144aabbf13c42cfe450fc84536
Author: poorejc <[email protected]>
AuthorDate: Sun Jan 26 23:35:13 2020 -0500
[FLAGON-481] added pointers to Apache Flagon stack repo in readme
---
README.md | 26 ++++++++++++++++++++------
1 file changed, 20 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 3042236..fd8c1b4 100755
--- a/README.md
+++ b/README.md
@@ -13,11 +13,12 @@ Once included in your project, Apache UserALE.js provides
comprehensive logging
Additional documentation and a demonstration can be found at the [Apache
Flagon website](http://flagon.incubator.apache.org/userale/).
### Table of Contents
-[What's New in the Current
Version](https://github.com/apache/incubator-flagon-useralejs#whats-new-in-version-202)
+[What's
New](https://github.com/apache/incubator-flagon-useralejs#whats-new-in-version-202)
[Installation](https://github.com/apache/incubator-flagon-useralejs#installation)
[Configure](https://github.com/apache/incubator-flagon-useralejs#configure)
[Usage](https://github.com/apache/incubator-flagon-useralejs#usage)
[Examples](https://github.com/apache/incubator-flagon-useralejs#examples)
+[Indexing and Storage](https://github.com/apache/indexing-and-storage)
[Modifying
Source](https://github.com/apache/incubator-flagon-useralejs#modifying-source)
[Contributing](https://github.com/apache/incubator-flagon-useralejs#contributing)
[License](https://github.com/apache/incubator-flagon-useralejs#license)
@@ -70,7 +71,14 @@ We also support a
[WebExtension](https://github.com/apache/incubator-flagon-user
## Configure
-Some configuration is necessary. At minimum you will need to provide
UserALE.js an end-point to ship logs to; default behavior is to ship logs to
`localhost:8000/`.
+Some configuration is necessary. At minimum you will need to provide
UserALE.js an end-point to ship logs to; default behavior is to ship logs to
`localhost:8000`.
+
+**NOTE**: In order to facilitate testing configuration and usage of
UserALE.js, we have included an [example logging
server](https://github.com/apache/incubator-flagon-useralejs/tree/master/example#capturing-logs-using-the-logging-server)
in our
+[example
directory](https://github.com/apache/incubator-flagon-useralejs/tree/master/example).
This is a very helpful utility
+that works with both included [module
examples](https://github.com/apache/incubator-flagon-useralejs/tree/master/example/webpackUserAleExample)
+and [script-tag
examples](https://github.com/apache/incubator-flagon-useralejs/tree/master/example).
We strongly recommend experimenting with it.
+
+Configuration details follow:
If you have included UserALE.js in your project as a `module`, you will need
to use our 'userale.options' function, which exposes library configuration
options through our API:
@@ -133,9 +141,6 @@ You have access to the same parameters listed above,
however, naming conventions
If you are using our
[WebExtension](https://github.com/apache/incubator-flagon-useralejs/tree/master/src/UserALEWebExtension),
you can modify some of these parameters via the extensions' 'options' page.
-
-To build UserALE.js, you will need to download our source (here), our [release
distributions](http://flagon.incubator.apache.org/releases/) or include in your
project via the [flagon-userale NPM
module](https://www.npmjs.com/package/flagon-userale).
-
## Usage
Including UserALE.js in your project as a `module` attaches the UserALE.js
script as an object to the page.
@@ -167,7 +172,8 @@ userale.options = window.userale.options
## Examples
-We provide a number of examples to illustrate how the [functions
above](https://github.com/apache/incubator-flagon-useralejs#usage) can be used
with sample webpages and logging servers. These are tailed for [module
examples](https://github.com/apache/incubator-flagon-useralejs/tree/master/example/webpackUserAleExample)
+We provide a number of examples to illustrate how the [functions
above](https://github.com/apache/incubator-flagon-useralejs#usage)
+can be used with sample webpages and logging servers. These are tailored for
[module
examples](https://github.com/apache/incubator-flagon-useralejs/tree/master/example/webpackUserAleExample)
and [script-tag
examples](https://github.com/apache/incubator-flagon-useralejs/tree/master/example).
Select examples are below:
@@ -245,6 +251,14 @@ Again, see
[Usage](https://github.com/apache/incubator-flagon-useralejs#usage) f
You can find additional examples on our
[website](http://flagon.incubator.apache.org/docs/useralejs/API/).
+## Indexing and Storing Logs
+
+We recommend Elastic products, specifically an [ELK
cluster](https://github.com/apache/incubator-flagon-useralejs#examples), for
indexing and storing logs in productions.
+
+You can find a 'sand-box' ELK build, configuration files, and
visualization/dashboards tailored for UserALE.js in the [Apache Flagon parent
repository](https://github.com/apache/incubator-flagon/tree/master/docker).
+
+We also provide some documentation about stack-considerations on our [project
website](http://flagon.incubator.apache.org/docs/stack/).
+
## Modifying Source
You may wish to modify UserALE.js to suite your needs. After making
modification to [UserALE.js
src](https://github.com/apache/incubator-flagon-useralejs/tree/master/src),
