You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our logging for ES calls was way too verbose. This defaults to INFO which seems good, but leaves the ability to easily move to DEBUG if we need the verbosity.
Also clarifies how to fully disable ES logging in README.
Copy file name to clipboardExpand all lines: README.md
+18-2Lines changed: 18 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,14 +23,15 @@ additional records with a standardized template.
23
23
## Publishing User Facing Documentation
24
24
25
25
### Automatic generation from openapi specification
26
+
26
27
- Sign into stoplight.io with an account that has access to the MIT Libraries organization
27
28
- copy the source of `openapi.json` file from this repository to the code tab in our [stoplight model](https://next.stoplight.io/mit-libraries/timdex/version%2F1.0/openapi.oas3.yml)
28
29
- In [Stoplight's Publish](https://next.stoplight.io/mit-libraries/timdex/version%2F1.0/timdex.hub.yml?view=/&show=publish&domain=mitlibraries-timdex.docs.stoplight.io) section, Uncheck "set live" and then click "Build"
29
30
- Once docs are built, check they are sane with the preview feature then click "set live"
30
31
31
32
## Required Environment Variables (all ENVs)
32
33
33
-
-`EMAIL_FROM`: email address to send message from, including the registration
34
+
-`EMAIL_FROM`: email address to send message from, including the registration
34
35
and forgot password messages.
35
36
-`EMAIL_URL_HOST` - base url to use when sending emails that link back to the
36
37
application. In development, often `localhost:3000`. On heroku, often
@@ -41,6 +42,7 @@ additional records with a standardized template.
41
42
-`ELASTICSEARCH_URL`: defaults to `http://localhost:9200`
42
43
43
44
## Production required Environment Variables
45
+
44
46
-`AWS_ACCESS_KEY`
45
47
-`AWS_ELASTICSEARCH`: boolean. Set to true to enable AWSv4 Signing
46
48
-`AWS_SECRET_ACCESS_KEY`
@@ -51,7 +53,21 @@ additional records with a standardized template.
51
53
-`SMTP_USER`
52
54
53
55
## Optional Environment Variables (all ENVs)
54
-
-`ELASTICSEARCH_LOG` if `true`, verbosely logs ElasticSearch queries
56
+
57
+
-`ELASTICSEARCH_LOG` if `true`, verbosely logs ElasticSearch queries.
58
+
59
+
```text
60
+
NOTE: do not set this ENV at all if you want ES logging fully disabled.
61
+
Setting it to `false` is still setting it and you will be annoyed and
62
+
confused.
63
+
```
64
+
65
+
-`ES_LOG_LEVEL` set elasticsearch transport log level. Defaults to `INFO`.
66
+
67
+
```text
68
+
NOTE: `ELASTICSEARCH_LOG` must also be set for logging to function.
69
+
```
70
+
55
71
-`PREFERRED_DOMAIN` - set this to the domain you would like to to use. Any
56
72
other requests that come to the app will redirect to the root of this domain.
57
73
This is useful to prevent access to herokuapp.com domains.
0 commit comments