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
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ One way to run an unpacked archive is by starting the appropriate launcher, as f
22
22
----
23
23
24
24
This is actually slightly faster on startup (depending on the size of the jar) than running from an unexploded archive.
25
-
At runtime you shouldn't expect any differences.
25
+
At runtime you should not expect any differences.
26
26
27
27
Once you have unpacked the jar file, you can also get an extra boost to startup time by running the app with its "natural" main method instead of the `JarLauncher`. For example:
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ TIP: If you do not use Spring Data MongoDB, you can inject a `MongoClient` bean
109
109
If you want to take complete control of establishing the MongoDB connection, you can also declare your own `MongoDatabaseFactory` or `MongoClient` bean.
110
110
111
111
NOTE: If you are using the reactive driver, Netty is required for SSL.
112
-
The auto-configuration configures this factory automatically if Netty is available and the factory to use hasn't been customized already.
112
+
The auto-configuration configures this factory automatically if Netty is available and the factory to use has not been customized already.
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/cloud.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -140,7 +140,7 @@ Once the pre-stop hook has completed, SIGTERM will be sent to the container and
140
140
141
141
NOTE: When Kubernetes sends a SIGTERM signal to the pod, it waits for a specified time called the termination grace period (the default for which is 30 seconds).
142
142
If the containers are still running after the grace period, they are sent the SIGKILL signal and forcibly removed.
143
-
If the pod takes longer than 30 seconds to shut down, which could be because you've increased configprop:spring.lifecycle.timeout-per-shutdown-phase[], make sure to increase the termination grace period by setting the `terminationGracePeriodSeconds` option in the Pod YAML.
143
+
If the pod takes longer than 30 seconds to shut down, which could be because you have increased configprop:spring.lifecycle.timeout-per-shutdown-phase[], make sure to increase the termination grace period by setting the `terminationGracePeriodSeconds` option in the Pod YAML.
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-auto-configuration.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -108,7 +108,7 @@ The only difference between using these conditions at the class level and markin
108
108
109
109
TIP: When declaring a `@Bean` method, provide as much type information as possible in the method's return type.
110
110
For example, if your bean's concrete class implements an interface the bean method's return type should be the concrete class and not the interface.
111
-
Providing as much type information as possible in `@Bean` methods is particularly important when using bean conditions as their evaluation can only rely upon to type information that's available in the method signature.
111
+
Providing as much type information as possible in `@Bean` methods is particularly important when using bean conditions as their evaluation can only rely upon to type information that is available in the method signature.
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -134,7 +134,7 @@ The following example shows how to specify two distinct files:
134
134
optional:classpath:/override.properties
135
135
----
136
136
137
-
TIP: Use the prefix `optional:` if the <<features#features.external-config.files.optional-prefix,locations are optional>> and you don't mind if they don't exist.
137
+
TIP: Use the prefix `optional:` if the <<features#features.external-config.files.optional-prefix,locations are optional>> and you do not mind if they do not exist.
138
138
139
139
WARNING: `spring.config.name`, `spring.config.location`, and `spring.config.additional-location` are used very early to determine which files have to be loaded.
140
140
They must be defined as an environment property (typically an OS environment variable, a system property, or a command-line argument).
@@ -186,7 +186,7 @@ NOTE: If your application runs in a servlet container or application server, the
186
186
==== Optional Locations
187
187
By default, when a specified config data location does not exist, Spring Boot will throw a `ConfigDataLocationNotFoundException` and your application will not start.
188
188
189
-
If you want to specify a location, but you don't mind if it doesn't always exist, you can use the `optional:` prefix.
189
+
If you want to specify a location, but you do not mind if it does not always exist, you can use the `optional:` prefix.
190
190
You can use this prefix with the `spring.config.location` and `spring.config.additional-location` properties, as well as with <<features#features.external-config.files.importing, `spring.config.import`>> declarations.
191
191
192
192
For example, a `spring.config.import` value of `optional:file:./myconfig.properties` allows your application to start, even if the `myconfig.properties` file is missing.
@@ -261,7 +261,7 @@ The `Environment` has a set of default profiles (by default, `[default]`) that a
261
261
In other words, if no profiles are explicitly activated, then properties from `application-default` are considered.
262
262
263
263
NOTE: Properties files are only ever loaded once.
264
-
If you've already directly <<features#features.external-config.files.importing,imported>> a profile specific property files then it won't be imported a second time.
264
+
If you have already directly <<features#features.external-config.files.importing,imported>> a profile specific property files then it will not be imported a second time.
265
265
266
266
267
267
@@ -286,7 +286,7 @@ Values from the imported `dev.properties` will take precedence over the file tha
286
286
In the above example, the `dev.properties` could redefine `spring.application.name` to a different value.
287
287
288
288
An import will only be imported once no matter how many times it is declared.
289
-
The order an import is defined inside a single document within the properties/yaml file doesn't matter.
289
+
The order an import is defined inside a single document within the properties/yaml file does not matter.
290
290
For instance, the two examples below produce the same result:
@@ -320,7 +320,7 @@ The example above would import both `my.properties` as well as any `my-<profile>
320
320
Spring Boot includes pluggable API that allows various different location addresses to be supported.
321
321
By default you can import Java Properties, YAML and "`<<features#features.external-config.files.configtree, configuration trees>>`".
322
322
323
-
Third-party jars can offer support for additional technologies (there's no requirement for files to be local).
323
+
Third-party jars can offer support for additional technologies (there is no requirement for files to be local).
324
324
For example, you can imagine config data being from external stores such as Consul, Apache ZooKeeper or Netflix Archaius.
325
325
326
326
If you want to support your own locations, see the `ConfigDataLocationResolver` and `ConfigDataLoader` classes in the `org.springframework.boot.context.config` package.
@@ -349,7 +349,7 @@ You can import it from your `application.properties` using the following:
349
349
[[features.external-config.files.configtree]]
350
350
==== Using Configuration Trees
351
351
When running applications on a cloud platform (such as Kubernetes) you often need to read config values that the platform supplies.
352
-
It's not uncommon to use environment variables for such purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.
352
+
It is not uncommon to use environment variables for such purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.
353
353
354
354
As an alternative to environment variables, many cloud platforms now allow you to map configuration into mounted data volumes.
355
355
For example, Kubernetes can volume mount both https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap[`ConfigMaps`] and https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod[`Secrets`].
@@ -495,7 +495,7 @@ WARNING: Multi-document property files cannot be loaded by using the `@PropertyS
It's sometimes useful to only activate a given get of properties when certain conditions are met.
498
+
It is sometimes useful to only activate a given get of properties when certain conditions are met.
499
499
For example, you might have properties that are only relevant when a specific profile is active.
500
500
501
501
You can conditionally activate a properties document using `spring.config.activate.*`.
@@ -903,7 +903,7 @@ For example, consider binding the following properties to a `Map<String,String>`
903
903
NOTE: For YAML files, the brackets need to be surrounded by quotes for the keys to be parsed properly.
904
904
905
905
The properties above will bind to a `Map` with `/key1`, `/key2` and `key3` as the keys in the map.
906
-
The slash has been removed from `key3` because it wasn't surrounded by square brackets.
906
+
The slash has been removed from `key3` because it was not surrounded by square brackets.
907
907
908
908
You may also occasionally need to use the bracket notation if your `key` contains a `.` and you are binding to non-scalar value.
909
909
For example, binding `a.b=c` to `Map<String, Object>` will return a Map with the entry `{"a"={"b"="c"}}` whereas `[a.b]=c` will return a Map with the entry `{"a.b"="c"}`.
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/logging.adoc
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -161,8 +161,8 @@ As a result, specific configuration keys (such as `logback.configurationFile` fo
161
161
162
162
[[features.logging.file-rotation]]
163
163
=== File Rotation
164
-
If you are using the Logback, it's possible to fine-tune log rotation settings using your `application.properties` or `application.yaml` file.
165
-
For all other logging system, you'll need to configure rotation settings directly yourself (for example, if you use Log4J2 then you could add a `log4j.xml` file).
164
+
If you are using the Logback, it is possible to fine-tune log rotation settings using your `application.properties` or `application.yaml` file.
165
+
For all other logging system, you will need to configure rotation settings directly yourself (for example, if you use Log4J2 then you could add a `log4j.xml` file).
166
166
167
167
The following rotation policy properties are supported:
168
168
@@ -176,7 +176,7 @@ The following rotation policy properties are supported:
176
176
| If log archive cleanup should occur when the application starts.
| The maximum amount of size log archives can take before being deleted.
@@ -212,22 +212,22 @@ The following example shows potential logging settings in `application.propertie
212
212
org.hibernate: "error"
213
213
----
214
214
215
-
It's also possible to set logging levels using environment variables.
215
+
It is also possible to set logging levels using environment variables.
216
216
For example, `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG` will set `org.springframework.web` to `DEBUG`.
217
217
218
218
NOTE: The above approach will only work for package level logging.
219
-
Since relaxed binding always converts environment variables to lowercase, it's not possible to configure logging for an individual class in this way.
219
+
Since relaxed binding always converts environment variables to lowercase, it is not possible to configure logging for an individual class in this way.
220
220
If you need to configure logging for a class, you can use <<features#features.external-config.application-json, the `SPRING_APPLICATION_JSON`>> variable.
221
221
222
222
223
223
224
224
[[features.logging.log-groups]]
225
225
=== Log Groups
226
-
It's often useful to be able to group related loggers together so that they can all be configured at the same time.
227
-
For example, you might commonly change the logging levels for _all_ Tomcat related loggers, but you can't easily remember top level packages.
226
+
It is often useful to be able to group related loggers together so that they can all be configured at the same time.
227
+
For example, you might commonly change the logging levels for _all_ Tomcat related loggers, but you can not easily remember top level packages.
228
228
229
229
To help with this, Spring Boot allows you to define logging groups in your Spring `Environment`.
230
-
For example, here's how you could define a "`tomcat`" group by adding it to your `application.properties`:
230
+
For example, here is how you could define a "`tomcat`" group by adding it to your `application.properties`:
The "`Liveness`" state of an application tells whether its internal state allows it to work correctly, or recover by itself if it's currently failing.
212
+
The "`Liveness`" state of an application tells whether its internal state allows it to work correctly, or recover by itself if it is currently failing.
213
213
A broken "`Liveness`" state means that the application is in a state that it cannot recover from, and the infrastructure should restart the application.
214
214
215
215
NOTE: In general, the "Liveness" state should not be based on external checks, such as <<actuator#actuator.endpoints.health, Health checks>>.
@@ -225,7 +225,7 @@ An application is considered live as soon as the context has been refreshed, see
225
225
==== Readiness State
226
226
The "`Readiness`" state of an application tells whether the application is ready to handle traffic.
227
227
A failing "`Readiness`" state tells the platform that it should not route traffic to the application for now.
228
-
This typically happens during startup, while `CommandLineRunner` and `ApplicationRunner` components are being processed, or at any time if the application decides that it's too busy for additional traffic.
228
+
This typically happens during startup, while `CommandLineRunner` and `ApplicationRunner` components are being processed, or at any time if the application decides that it is too busy for additional traffic.
229
229
230
230
An application is considered ready as soon as application and command-line runners have been called, see <<features#features.spring-application.application-events-and-listeners, Spring Boot application lifecycle and related Application Events>>.
0 commit comments