From cf527fda8019d184fe1bad591a3e8ee72eb8540e Mon Sep 17 00:00:00 2001 From: buildmaster Date: Sat, 29 Sep 2018 10:46:21 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__addressing_all_instances_of_a_service.html | 4 ++-- multi/multi__addressing_an_instance.html | 4 ++-- multi/multi__broadcasting_your_own_events.html | 2 +- multi/multi__bus_endpoints.html | 2 +- multi/multi__customizing_the_message_broker.html | 2 +- multi/multi__quick_start.html | 2 +- multi/multi__service_id_must_be_unique.html | 2 +- multi/multi__tracing_bus_events.html | 2 +- multi/multi_pr01.html | 2 +- multi/multi_spring-cloud-bus.html | 2 +- single/spring-cloud-bus.html | 8 ++++---- spring-cloud-bus.html | 2 +- spring-cloud-bus.xml | 6 +++--- 13 files changed, 20 insertions(+), 20 deletions(-) diff --git a/multi/multi__addressing_all_instances_of_a_service.html b/multi/multi__addressing_all_instances_of_a_service.html index 13d3c7e..63ba842 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 @@ - 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 + 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-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 +“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 cf5a546..5dfa9fe 100644 --- a/multi/multi__addressing_an_instance.html +++ b/multi/multi__addressing_an_instance.html @@ -1,12 +1,12 @@ - 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 + 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” path parameter, such as +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
    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 df90368..ce1eb98 100644 --- a/multi/multi__broadcasting_your_own_events.html +++ b/multi/multi__broadcasting_your_own_events.html @@ -1,6 +1,6 @@ - 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 + 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 diff --git a/multi/multi__bus_endpoints.html b/multi/multi__bus_endpoints.html index b0dbc5d..5abc156 100644 --- a/multi/multi__bus_endpoints.html +++ b/multi/multi__bus_endpoints.html @@ -1,6 +1,6 @@ - 2. Bus Endpoints

    2. Bus Endpoints
    Prev   Next

    2. Bus Endpoints

    Spring Cloud Bus provides two endpoints, /actuator/bus-refresh and /actuator/bus-env + 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 diff --git a/multi/multi__customizing_the_message_broker.html b/multi/multi__customizing_the_message_broker.html index 96336cc..3abf730 100644 --- a/multi/multi__customizing_the_message_broker.html +++ b/multi/multi__customizing_the_message_broker.html @@ -1,6 +1,6 @@ - 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 + 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 diff --git a/multi/multi__quick_start.html b/multi/multi__quick_start.html index 54ccaaa..4c79f03 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 diff --git a/multi/multi__service_id_must_be_unique.html b/multi/multi__service_id_must_be_unique.html index 1f2c0d9..7cc955e 100644 --- a/multi/multi__service_id_must_be_unique.html +++ b/multi/multi__service_id_must_be_unique.html @@ -1,6 +1,6 @@ - 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 + 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 diff --git a/multi/multi__tracing_bus_events.html b/multi/multi__tracing_bus_events.html index 316eca4..6a0d5e8 100644 --- a/multi/multi__tracing_bus_events.html +++ b/multi/multi__tracing_bus_events.html @@ -1,6 +1,6 @@ - 7. Tracing Bus Events

    7. Tracing Bus Events
    Prev   Next

    7. 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:

    {
diff --git a/multi/multi_pr01.html b/multi/multi_pr01.html
index 1e178ff..97d8198 100644
--- a/multi/multi_pr01.html
+++ b/multi/multi_pr01.html
@@ -1,6 +1,6 @@
 
       
-   
    Prev   Next
    Spring Cloud Bus links the nodes of a distributed system with a lightweight message
+   
    Prev   Next
    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
diff --git a/multi/multi_spring-cloud-bus.html b/multi/multi_spring-cloud-bus.html
index 45c5fb6..888f42d 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. 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
+   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 0f13097..f9e18d9 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. 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
+   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
@@ -41,13 +41,13 @@ 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” path parameter, such as
+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.
    4. 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-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
+“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
diff --git a/spring-cloud-bus.html b/spring-cloud-bus.html
index 1e70112..a820994 100644
--- a/spring-cloud-bus.html
+++ b/spring-cloud-bus.html
@@ -4,7 +4,7 @@
 
 
 
-
+
 spring-cloud-bus