From 46e05dcff64003079928c2c8d79bf243c775d33c Mon Sep 17 00:00:00 2001 From: buildmaster Date: Fri, 15 Jun 2018 18:11:18 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- ...addressing_all_instances_of_a_service.html | 6 ++-- multi/multi__addressing_an_instance.html | 8 ++--- .../multi__broadcasting_your_own_events.html | 6 ++-- multi/multi__bus_endpoints.html | 13 +++++++ ...multi__customizing_the_message_broker.html | 4 +-- multi/multi__quick_start.html | 4 +-- multi/multi__service_id_must_be_unique.html | 4 +-- multi/multi__tracing_bus_events.html | 4 +-- multi/multi_spring-cloud-bus.html | 2 +- single/spring-cloud-bus.html | 32 +++++++++++------ spring-cloud-bus.xml | 34 +++++++++++++++++-- 11 files changed, 84 insertions(+), 33 deletions(-) create mode 100644 multi/multi__bus_endpoints.html diff --git a/multi/multi__addressing_all_instances_of_a_service.html b/multi/multi__addressing_all_instances_of_a_service.html index ff921d3..13d3c7e 100644 --- a/multi/multi__addressing_all_instances_of_a_service.html +++ b/multi/multi__addressing_all_instances_of_a_service.html @@ -1,6 +1,6 @@ - 3. Addressing All Instances of a Service
3. Addressing All Instances of a Service
Prev   Next

3. Addressing All Instances of a Service

The “destination” parameter is used in a Spring PathMatcher (with the path separator + 4. Addressing All Instances of a Service

4. Addressing All Instances of a Service
Prev   Next

4. Addressing All Instances of a Service

The “destination” parameter is used in a Spring PathMatcher (with the path separator as a colon — :) to determine if an instance processes the message. Using the example -from earlier, /bus/refresh?destination=customers:** targets all instances of the -“customers” service regardless of the rest of the service ID.

Prev   Next
2. Addressing an Instance Home 4. Service ID Must Be Unique
\ No newline at end of file +from earlier, /bus-env/customers:** targets all instances of the +“customers” service regardless of the rest of the service ID.

Prev   Next
3. Addressing an Instance Home 5. Service ID Must Be Unique
\ No newline at end of file diff --git a/multi/multi__addressing_an_instance.html b/multi/multi__addressing_an_instance.html index e67a14a..cf5a546 100644 --- a/multi/multi__addressing_an_instance.html +++ b/multi/multi__addressing_an_instance.html @@ -1,12 +1,12 @@ - 2. Addressing an Instance
2. Addressing an Instance
Prev   Next

2. Addressing an Instance

Each instance of the application has a service ID, whose value can be set with + 3. Addressing an Instance

3. Addressing an Instance
Prev   Next

3. Addressing an Instance

Each instance of the application has a service ID, whose value can be set with spring.cloud.bus.id and whose value is expected to be a colon-separated list of identifiers, in order from least specific to most specific. The default value is constructed from the environment as a combination of the spring.application.name and server.port (or spring.application.index, if set). The default value of the ID is constructed in the form of app:index:id, where:

  • app is the vcap.application.name, if it exists, or spring.application.name
  • index is the vcap.application.instance_index, if it exists, -spring.application.index, local.server.port, server.port, or 0 (in that order).
  • id is the vcap.application.instance_id, if it exists, or a random value.

The HTTP endpoints accept a “destination” parameter, such as -/bus/refresh?destination=customers:9000, where destination is a service ID. If the ID +spring.application.index, local.server.port, server.port, or 0 (in that order).

  • id is the vcap.application.instance_id, if it exists, or a random value.

    • The HTTP endpoints accept a “destination” path parameter, such as +/bus-refresh/customers:9000, where destination is a service ID. If the ID is owned by an instance on the bus, it processes the message, and all other instances -ignore it.

    Prev   Next
    1. Quick Start Home 3. Addressing All Instances of a Service
    \ No newline at end of file +ignore it.

    Prev   Next
    2. Bus Endpoints Home 4. Addressing All Instances of a Service
    \ No newline at end of file diff --git a/multi/multi__broadcasting_your_own_events.html b/multi/multi__broadcasting_your_own_events.html index 5154097..df90368 100644 --- a/multi/multi__broadcasting_your_own_events.html +++ b/multi/multi__broadcasting_your_own_events.html @@ -1,10 +1,10 @@ - 7. Broadcasting Your Own Events
    7. Broadcasting Your Own Events
    Prev   

    7. Broadcasting Your Own Events

    The Bus can carry any event of type RemoteApplicationEvent. The default transport is + 8. Broadcasting Your Own Events

    8. Broadcasting Your Own Events
    Prev   

    8. Broadcasting Your Own Events

    The Bus can carry any event of type RemoteApplicationEvent. The default transport is JSON, and the deserializer needs to know which types are going to be used ahead of time. To register a new type, you must put it in a subpackage of org.springframework.cloud.bus.event.

    To customise the event name, you can use @JsonTypeName on your custom class or rely on -the default strategy, which is to use the simple name of the class.

    [Note]Note

    Both the producer and the consumer need access to the class definition.

    7.1 Registering events in custom packages

    If you cannot or do not want to use a subpackage of org.springframework.cloud.bus.event +the default strategy, which is to use the simple name of the class.

    [Note]Note

    Both the producer and the consumer need access to the class definition.

    8.1 Registering events in custom packages

    If you cannot or do not want to use a subpackage of org.springframework.cloud.bus.event for your custom events, you must specify which packages to scan for events of type RemoteApplicationEvent by using the @RemoteApplicationEventScan annotation. Packages specified with @RemoteApplicationEventScan include subpackages.

    For example, consider the following custom event, called MyEvent:

    package com.acme;
@@ -31,4 +31,4 @@ following example:
    @RemoteApplicationEventScan are equivalent, in that the
 com.acme package is registered by explicitly specifying the packages on
-@RemoteApplicationEventScan.
    [Note]Note
    You can specify multiple base packages to scan.
    Prev   
    6. Tracing Bus Events Home 
    \ No newline at end of file +@RemoteApplicationEventScan.

    [Note]Note

    You can specify multiple base packages to scan.

    Prev   
    7. Tracing Bus Events Home 
    \ No newline at end of file diff --git a/multi/multi__bus_endpoints.html b/multi/multi__bus_endpoints.html new file mode 100644 index 0000000..b0dbc5d --- /dev/null +++ b/multi/multi__bus_endpoints.html @@ -0,0 +1,13 @@ + + + 2. Bus Endpoints
    2. Bus Endpoints
    Prev   Next

    2. Bus Endpoints

    Spring Cloud Bus provides two endpoints, /actuator/bus-refresh and /actuator/bus-env +that correspond to individual actuator endpoints in Spring Cloud Commons, +/actuator/refresh and /actuator/env respectively.

    2.1 Bus Refresh Endpoint

    The /actuator/bus-refresh endpoint clears the RefreshScope cache and rebinds +@ConfigurationProperties. See the Refresh Scope documentation for +more information.

    To expose the /actuator/bus-refresh endpoint, you need to add following configuration to your +application:

    management.endpoints.web.exposure.include=bus-refresh

    2.2 Bus Env Endpoint

    The /actuator/bus-env endpoint updates each instances environment with the specified +key/value pair across multiple instances.

    To expose the /actuator/bus-env endpoint, you need to add following configuration to your +application:

    management.endpoints.web.exposure.include=bus-env

    The /actuator/bus-env endpoint accepts POST requests with the following shape:

    {
+	"name": "key1",
+	"value": "value1"
+}
    Prev   Next
    1. Quick Start Home 3. Addressing an Instance
    \ No newline at end of file diff --git a/multi/multi__customizing_the_message_broker.html b/multi/multi__customizing_the_message_broker.html index a2ebcc8..96336cc 100644 --- a/multi/multi__customizing_the_message_broker.html +++ b/multi/multi__customizing_the_message_broker.html @@ -1,6 +1,6 @@ - 5. Customizing the Message Broker
    5. Customizing the Message Broker
    Prev   Next

    5. Customizing the Message Broker

    Spring Cloud Bus uses Spring Cloud Stream to + 6. Customizing the Message Broker

    6. Customizing the Message Broker
    Prev   Next

    6. Customizing the Message Broker

    Spring Cloud Bus uses Spring Cloud Stream to broadcast the messages. So, to get messages to flow, you need only include the binder implementation of your choice in the classpath. There are convenient starters for the bus with AMQP (RabbitMQ) and Kafka (spring-cloud-starter-bus-[amqp|kafka]). Generally @@ -10,4 +10,4 @@ configuring middleware. For instance, the AMQP broker address can be changed wit native configuration properties in spring.cloud.bus.* (for example, spring.cloud.bus.destination is the name of the topic to use as the external middleware). Normally, the defaults suffice.

    To learn more about how to customize the message broker settings, consult the Spring Cloud -Stream documentation.

    Prev   Next
    4. Service ID Must Be Unique Home 6. Tracing Bus Events
    \ No newline at end of file +Stream documentation.

    Prev   Next
    5. Service ID Must Be Unique Home 7. Tracing Bus Events
    \ No newline at end of file diff --git a/multi/multi__quick_start.html b/multi/multi__quick_start.html index 082fb34..54ccaaa 100644 --- a/multi/multi__quick_start.html +++ b/multi/multi__quick_start.html @@ -1,6 +1,6 @@ - 1. Quick Start
    1. Quick Start
    Prev   Next

    1. Quick Start

    Spring Cloud Bus works by adding Spring Boot autconfiguration if it detects itself on the + 1. Quick Start

    1. Quick Start
    Prev   Next

    1. Quick Start

    Spring Cloud Bus works by adding Spring Boot autconfiguration if it detects itself on the classpath. To enable the bus, add spring-cloud-starter-bus-amqp or spring-cloud-starter-bus-kafka to your dependency management. Spring Cloud takes care of the rest. Make sure the broker (RabbitMQ or Kafka) is available and configured. When @@ -20,4 +20,4 @@ update each node’s Spring Environment. The second, / application’s configuration, as though they had all been pinged on their /refresh endpoint.

    [Note]Note

    The Spring Cloud Bus starters cover Rabbit and Kafka, because those are the two most common implementations. However, Spring Cloud Stream is quite flexible, and the binder -works with spring-cloud-bus.

    Prev   Next
     Home 2. Addressing an Instance
    \ No newline at end of file +works with spring-cloud-bus.

    Prev   Next
     Home 2. Bus Endpoints
    \ No newline at end of file diff --git a/multi/multi__service_id_must_be_unique.html b/multi/multi__service_id_must_be_unique.html index f39aafd..1f2c0d9 100644 --- a/multi/multi__service_id_must_be_unique.html +++ b/multi/multi__service_id_must_be_unique.html @@ -1,9 +1,9 @@ - 4. Service ID Must Be Unique
    4. Service ID Must Be Unique
    Prev   Next

    4. Service ID Must Be Unique

    The bus tries twice to eliminate processing an event — once from the original + 5. Service ID Must Be Unique

    5. Service ID Must Be Unique
    Prev   Next

    5. Service ID Must Be Unique

    The bus tries twice to eliminate processing an event — once from the original ApplicationEvent and once from the queue. To do so, it checks the sending service ID against the current service ID. If multiple instances of a service have the same ID, events are not processed. When running on a local machine, each service is on a different port, and that port is part of the ID. Cloud Foundry supplies an index to differentiate. To ensure that the ID is unique outside Cloud Foundry, set spring.application.index to -something unique for each instance of a service.

    Prev   Next
    3. Addressing All Instances of a Service Home 5. Customizing the Message Broker
    \ No newline at end of file +something unique for each instance of a service.

    Prev   Next
    4. Addressing All Instances of a Service Home 6. Customizing the Message Broker
    \ No newline at end of file diff --git a/multi/multi__tracing_bus_events.html b/multi/multi__tracing_bus_events.html index e5bf36c..316eca4 100644 --- a/multi/multi__tracing_bus_events.html +++ b/multi/multi__tracing_bus_events.html @@ -1,6 +1,6 @@ - 6. Tracing Bus Events
    6. Tracing Bus Events
    Prev   Next

    6. Tracing Bus Events

    Bus events (subclasses of RemoteApplicationEvent) can be traced by setting + 7. Tracing Bus Events

    7. Tracing Bus Events
    Prev   Next

    7. Tracing Bus Events

    Bus events (subclasses of RemoteApplicationEvent) can be traced by setting spring.cloud.bus.trace.enabled=true. If you do so, the Spring Boot TraceRepository (if it is present) shows each event sent and all the acks from each service instance. The following example comes from the /trace endpoint:

    {
@@ -39,4 +39,4 @@ following example comes from the /trace endpoint:TraceRepository and mine the data from
 there.
    [Note]Note
    Any Bus application can trace acks. However, sometimes, it is
 useful to do this in a central service that can do more complex
-queries on the data or forward it to a specialized tracing service.
    Prev   Next
    5. Customizing the Message Broker Home 7. Broadcasting Your Own Events
    \ No newline at end of file +queries on the data or forward it to a specialized tracing service.

    Prev   Next
    6. Customizing the Message Broker Home 8. Broadcasting Your Own Events
    \ No newline at end of file diff --git a/multi/multi_spring-cloud-bus.html b/multi/multi_spring-cloud-bus.html index feb7483..45c5fb6 100644 --- a/multi/multi_spring-cloud-bus.html +++ b/multi/multi_spring-cloud-bus.html @@ -1,3 +1,3 @@ - Spring Cloud Bus
    Spring Cloud Bus
       Next

    Spring Cloud Bus

    Table of Contents

    1. Quick Start
    2. Addressing an Instance
    3. Addressing All Instances of a Service
    4. Service ID Must Be Unique
    5. Customizing the Message Broker
    6. Tracing Bus Events
    7. Broadcasting Your Own Events
    7.1. Registering events in custom packages
       Next
       
    \ No newline at end of file + Spring Cloud Bus
    Spring Cloud Bus
       Next

    Spring Cloud Bus

    Table of Contents

    1. Quick Start
    2. Bus Endpoints
    2.1. Bus Refresh Endpoint
    2.2. Bus Env Endpoint
    3. Addressing an Instance
    4. Addressing All Instances of a Service
    5. Service ID Must Be Unique
    6. Customizing the Message Broker
    7. Tracing Bus Events
    8. Broadcasting Your Own Events
    8.1. Registering events in custom packages
       Next
       
    \ No newline at end of file diff --git a/single/spring-cloud-bus.html b/single/spring-cloud-bus.html index bc9e572..0f13097 100644 --- a/single/spring-cloud-bus.html +++ b/single/spring-cloud-bus.html @@ -1,6 +1,6 @@ - Spring Cloud Bus

    Spring Cloud Bus

    Table of Contents

    1. Quick Start
    2. Addressing an Instance
    3. Addressing All Instances of a Service
    4. Service ID Must Be Unique
    5. Customizing the Message Broker
    6. Tracing Bus Events
    7. Broadcasting Your Own Events
    7.1. Registering events in custom packages

    Spring Cloud Bus links the nodes of a distributed system with a lightweight message + Spring Cloud Bus

    Spring Cloud Bus

    Table of Contents

    1. Quick Start
    2. Bus Endpoints
    2.1. Bus Refresh Endpoint
    2.2. Bus Env Endpoint
    3. Addressing an Instance
    4. Addressing All Instances of a Service
    5. Service ID Must Be Unique
    6. Customizing the Message Broker
    7. Tracing Bus Events
    8. Broadcasting Your Own Events
    8.1. Registering events in custom packages

    Spring Cloud Bus links the nodes of a distributed system with a lightweight message broker. This broker can then be used to broadcast state changes (such as configuration changes) or other management instructions. A key idea is that the bus is like a distributed actuator for a Spring Boot application that is scaled out. However, it can @@ -25,25 +25,35 @@ update each node’s Spring Environment. The second, / application’s configuration, as though they had all been pinged on their /refresh endpoint.

    [Note]Note

    The Spring Cloud Bus starters cover Rabbit and Kafka, because those are the two most common implementations. However, Spring Cloud Stream is quite flexible, and the binder -works with spring-cloud-bus.

    2. Addressing an Instance

    Each instance of the application has a service ID, whose value can be set with +works with spring-cloud-bus.

    2. Bus Endpoints

    Spring Cloud Bus provides two endpoints, /actuator/bus-refresh and /actuator/bus-env +that correspond to individual actuator endpoints in Spring Cloud Commons, +/actuator/refresh and /actuator/env respectively.

    2.1 Bus Refresh Endpoint

    The /actuator/bus-refresh endpoint clears the RefreshScope cache and rebinds +@ConfigurationProperties. See the Refresh Scope documentation for +more information.

    To expose the /actuator/bus-refresh endpoint, you need to add following configuration to your +application:

    management.endpoints.web.exposure.include=bus-refresh

    2.2 Bus Env Endpoint

    The /actuator/bus-env endpoint updates each instances environment with the specified +key/value pair across multiple instances.

    To expose the /actuator/bus-env endpoint, you need to add following configuration to your +application:

    management.endpoints.web.exposure.include=bus-env

    The /actuator/bus-env endpoint accepts POST requests with the following shape:

    {
+	"name": "key1",
+	"value": "value1"
+}

    3. Addressing an Instance

    Each instance of the application has a service ID, whose value can be set with spring.cloud.bus.id and whose value is expected to be a colon-separated list of identifiers, in order from least specific to most specific. The default value is constructed from the environment as a combination of the spring.application.name and server.port (or spring.application.index, if set). The default value of the ID is constructed in the form of app:index:id, where:

    • app is the vcap.application.name, if it exists, or spring.application.name
    • index is the vcap.application.instance_index, if it exists, -spring.application.index, local.server.port, server.port, or 0 (in that order).
    • id is the vcap.application.instance_id, if it exists, or a random value.

    The HTTP endpoints accept a “destination” parameter, such as -/bus/refresh?destination=customers:9000, where destination is a service ID. If the ID +spring.application.index, local.server.port, server.port, or 0 (in that order).

  • id is the vcap.application.instance_id, if it exists, or a random value.

    • The HTTP endpoints accept a “destination” path parameter, such as +/bus-refresh/customers:9000, where destination is a service ID. If the ID is owned by an instance on the bus, it processes the message, and all other instances -ignore it.

    3. Addressing All Instances of a Service

    The “destination” parameter is used in a Spring PathMatcher (with the path separator +ignore it.

    4. Addressing All Instances of a Service

    The “destination” parameter is used in a Spring PathMatcher (with the path separator as a colon — :) to determine if an instance processes the message. Using the example -from earlier, /bus/refresh?destination=customers:** targets all instances of the -“customers” service regardless of the rest of the service ID.

    4. Service ID Must Be Unique

    The bus tries twice to eliminate processing an event — once from the original +from earlier, /bus-env/customers:** targets all instances of the +“customers” service regardless of the rest of the service ID.

    5. Service ID Must Be Unique

    The bus tries twice to eliminate processing an event — once from the original ApplicationEvent and once from the queue. To do so, it checks the sending service ID against the current service ID. If multiple instances of a service have the same ID, events are not processed. When running on a local machine, each service is on a different port, and that port is part of the ID. Cloud Foundry supplies an index to differentiate. To ensure that the ID is unique outside Cloud Foundry, set spring.application.index to -something unique for each instance of a service.

    5. Customizing the Message Broker

    Spring Cloud Bus uses Spring Cloud Stream to +something unique for each instance of a service.

    6. Customizing the Message Broker

    Spring Cloud Bus uses Spring Cloud Stream to broadcast the messages. So, to get messages to flow, you need only include the binder implementation of your choice in the classpath. There are convenient starters for the bus with AMQP (RabbitMQ) and Kafka (spring-cloud-starter-bus-[amqp|kafka]). Generally @@ -53,7 +63,7 @@ configuring middleware. For instance, the AMQP broker address can be changed wit native configuration properties in spring.cloud.bus.* (for example, spring.cloud.bus.destination is the name of the topic to use as the external middleware). Normally, the defaults suffice.

    To learn more about how to customize the message broker settings, consult the Spring Cloud -Stream documentation.

    6. Tracing Bus Events

    Bus events (subclasses of RemoteApplicationEvent) can be traced by setting +Stream documentation.

    7. Tracing Bus Events

    Bus events (subclasses of RemoteApplicationEvent) can be traced by setting spring.cloud.bus.trace.enabled=true. If you do so, the Spring Boot TraceRepository (if it is present) shows each event sent and all the acks from each service instance. The following example comes from the /trace endpoint:

    {
@@ -92,11 +102,11 @@ following example comes from the /trace endpoint:TraceRepository and mine the data from
 there.
    [Note]Note
    Any Bus application can trace acks. However, sometimes, it is
 useful to do this in a central service that can do more complex
-queries on the data or forward it to a specialized tracing service.

    7. Broadcasting Your Own Events

    The Bus can carry any event of type RemoteApplicationEvent. The default transport is +queries on the data or forward it to a specialized tracing service.

    8. Broadcasting Your Own Events

    The Bus can carry any event of type RemoteApplicationEvent. The default transport is JSON, and the deserializer needs to know which types are going to be used ahead of time. To register a new type, you must put it in a subpackage of org.springframework.cloud.bus.event.

    To customise the event name, you can use @JsonTypeName on your custom class or rely on -the default strategy, which is to use the simple name of the class.

    [Note]Note

    Both the producer and the consumer need access to the class definition.

    7.1 Registering events in custom packages

    If you cannot or do not want to use a subpackage of org.springframework.cloud.bus.event +the default strategy, which is to use the simple name of the class.

    [Note]Note

    Both the producer and the consumer need access to the class definition.

    8.1 Registering events in custom packages

    If you cannot or do not want to use a subpackage of org.springframework.cloud.bus.event for your custom events, you must specify which packages to scan for events of type RemoteApplicationEvent by using the @RemoteApplicationEventScan annotation. Packages specified with @RemoteApplicationEventScan include subpackages.

    For example, consider the following custom event, called MyEvent:

    package com.acme;
diff --git a/spring-cloud-bus.xml b/spring-cloud-bus.xml
index 728151a..097488b 100644
--- a/spring-cloud-bus.xml
+++ b/spring-cloud-bus.xml
@@ -50,6 +50,34 @@ common implementations. However, Spring Cloud Stream is quite flexible, and the
 works with spring-cloud-bus.
 
 
+
+Bus Endpoints
+Spring Cloud Bus provides two endpoints, /actuator/bus-refresh and /actuator/bus-env
+that correspond to individual actuator endpoints in Spring Cloud Commons,
+/actuator/refresh and /actuator/env respectively.
+
    
+Bus Refresh Endpoint
+The /actuator/bus-refresh endpoint clears the RefreshScope cache and rebinds
+@ConfigurationProperties. See the Refresh Scope documentation for
+more information.
+To expose the /actuator/bus-refresh endpoint, you need to add following configuration to your
+application:
+management.endpoints.web.exposure.include=bus-refresh
+
    
+
    
+Bus Env Endpoint
+The /actuator/bus-env endpoint updates each instances environment with the specified
+key/value pair across multiple instances.
+To expose the /actuator/bus-env endpoint, you need to add following configuration to your
+application:
+management.endpoints.web.exposure.include=bus-env
+The /actuator/bus-env endpoint accepts POST requests with the following shape:
+{
+	"name": "key1",
+	"value": "value1"
+}
+
    
+    
 
 Addressing an Instance
 Each instance of the application has a service ID, whose value can be set with
@@ -70,8 +98,8 @@ constructed in the form of app:index:id, where:
 id is the vcap.application.instance_id, if it exists, or a random value.
 
 
-The HTTP endpoints accept a “destination” parameter, such as
-/bus/refresh?destination=customers:9000, where destination is a service ID. If the ID
+The HTTP endpoints accept a “destination” path parameter, such as
+/bus-refresh/customers:9000, where destination is a service ID. If the ID
 is owned by an instance on the bus, it processes the message, and all other instances
 ignore it.
 
@@ -79,7 +107,7 @@ ignore it.
 Addressing All Instances of a Service
 The “destination” parameter is used in a Spring PathMatcher (with the path separator
 as a colon — :) to determine if an instance processes the message. Using the example
-from earlier, /bus/refresh?destination=customers:** targets all instances of the
+from earlier, /bus-env/customers:** targets all instances of the
 “customers” service regardless of the rest of the service ID.