Skip to content

Commit 3eaddfa

Browse files
committed
Version 0.6 for avaje-aws-appconfig and avaje-dynamic-logback
Please add some README docs
1 parent 46e2ee3 commit 3eaddfa

File tree

4 files changed

+109
-2
lines changed

4 files changed

+109
-2
lines changed

avaje-aws-appconfig/README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# avaje-aws-appconfig
2+
3+
This is a avaje-config ConfigurationSource that uses
4+
[AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html)
5+
as a source for configuration.
6+
7+
The AWS AppConfig content can either be in `yaml` or `properties`
8+
format.
9+
10+
This plugin will load configuration from the AWS AppConfig agent on initialisation
11+
and then additionally by polling the AppConfig agent (for changes to the config)
12+
and also when `Configuration.refresh()` is called.
13+
14+
## Configuration
15+
16+
- aws.appconfig.enabled - defaults to `true`
17+
- aws.appconfig.application - required
18+
- aws.appconfig.environment - required
19+
- aws.appconfig.configuration - defaults to `"default"`
20+
- aws.appconfig.pollingEnabled - defaults to `true`
21+
- aws.appconfig.pollingSeconds - defaults to `45` seconds
22+
- aws.appconfig.refreshSeconds - defaults to `(pollingSeconds - 1)`
23+
24+
25+
## Steps to use
26+
27+
### Add dependency
28+
29+
```xml
30+
<dependency>
31+
<groupId>io.avaje</groupId>
32+
<artifactId>avaje-aws-appconfig</artifactId>
33+
<version>...</version>
34+
</dependency>
35+
```
36+
37+
### Add to src/main/application.yaml
38+
39+
```yaml
40+
aws.appconfig:
41+
application: my-application
42+
environment: ${ENVIRONMENT:dev}
43+
configuration: default
44+
```
45+
46+
Or with more parameters like:
47+
48+
```yaml
49+
aws.appconfig:
50+
enabled: true
51+
application: my-application
52+
environment: ${ENVIRONMENT:dev}
53+
configuration: default
54+
pollingEnabled: true
55+
pollingSeconds: 60
56+
```
57+
58+
59+
### Add to src/test/application-test.yml
60+
61+
Turn it off for testing. When running tests we generally don't wish to
62+
pull configuration from AWS AppConfig.
63+
64+
```yaml
65+
aws.appconfig.enabled: false
66+
```

avaje-aws-appconfig/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<groupId>io.avaje</groupId>
1414
<artifactId>avaje-aws-appconfig</artifactId>
15-
<version>0.5</version>
15+
<version>0.6</version>
1616

1717
<properties>
1818
<surefire.useModulePath>false</surefire.useModulePath>

avaje-dynamic-logback/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# avaje-dynamic-logback
2+
3+
A plugin for avaje-config that dynamically changes the logging levels.
4+
5+
6+
## Configuring logging levels
7+
8+
Logging levels are configured by using `log.level.` as prefix, for example:
9+
10+
This plugin registers to listen to configuration changes the logging
11+
level for configuration changes that start with `log.level`
12+
13+
When configuration is first loaded and then whenever it is changed
14+
the logging level is changed.
15+
16+
17+
#### yaml
18+
```yaml
19+
log.level:
20+
com.example: INFO
21+
com.example.sample: TRACE
22+
```
23+
24+
#### properties
25+
```properties
26+
log.level.com.example=INFO
27+
log.level.com.example.sample=TRACE
28+
```
29+
30+
31+
## Steps to use
32+
33+
### Add dependency
34+
35+
```xml
36+
<dependency>
37+
<groupId>io.avaje</groupId>
38+
<artifactId>avaje-dynamic-logback</artifactId>
39+
<version>...</version>
40+
</dependency>
41+
```

avaje-dynamic-logback/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<groupId>io.avaje</groupId>
1414
<artifactId>avaje-dynamic-logback</artifactId>
15-
<version>0.1</version>
15+
<version>0.6</version>
1616

1717
<url>https://github.com/avaje/avaje-config/tree/master/avaje-dynamic-logback</url>
1818

0 commit comments

Comments
 (0)