From c3439ced78f7df89ae8ffd6b1a890d9e649f4faf Mon Sep 17 00:00:00 2001 From: Connie Date: Fri, 13 Dec 2019 11:13:00 -0800 Subject: [PATCH 1/3] Move old README into correct directory. --- sdk/eventhubs/{ => microsoft-azure-eventhubs}/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename sdk/eventhubs/{ => microsoft-azure-eventhubs}/README.md (100%) diff --git a/sdk/eventhubs/README.md b/sdk/eventhubs/microsoft-azure-eventhubs/README.md similarity index 100% rename from sdk/eventhubs/README.md rename to sdk/eventhubs/microsoft-azure-eventhubs/README.md From fa9c08ba5106e729b00f4faa184c5b1ec35675f0 Mon Sep 17 00:00:00 2001 From: Connie Date: Fri, 13 Dec 2019 12:59:57 -0800 Subject: [PATCH 2/3] Update READMEs for current released versions. --- .../azure-messaging-eventhubs-checkpointstore-blob/README.md | 2 +- sdk/eventhubs/azure-messaging-eventhubs/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md b/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md index 6035fe08f718..d0a55f1456a3 100644 --- a/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md +++ b/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md @@ -30,7 +30,7 @@ All client libraries, by default, use the Tomcat-native Boring SSL library to en com.azure azure-messaging-eventhubs-checkpointstore-blob - 1.0.0-preview.3 + 1.0.0-beta.4 ``` [//]: # ({x-version-update-end}) diff --git a/sdk/eventhubs/azure-messaging-eventhubs/README.md b/sdk/eventhubs/azure-messaging-eventhubs/README.md index 2e2d9783ed75..2d18142c964d 100644 --- a/sdk/eventhubs/azure-messaging-eventhubs/README.md +++ b/sdk/eventhubs/azure-messaging-eventhubs/README.md @@ -60,7 +60,7 @@ documentation][event_hubs_product_docs] | [Samples][sample_examples] com.azure azure-messaging-eventhubs - 5.0.0-preview.5 + 5.0.0-beta.6 ``` [//]: # ({x-version-update-end}) @@ -108,7 +108,7 @@ platform. First, add the package: com.azure azure-identity - 1.0.0 + 1.0.1 ``` [//]: # ({x-version-update-end}) From 5f3c6a5bfedd2bb4f8eccd3542d9d00c9bfe0ac9 Mon Sep 17 00:00:00 2001 From: Connie Date: Sat, 14 Dec 2019 20:45:41 -0800 Subject: [PATCH 3/3] Fix readme for track 1 --- .../microsoft-azure-eventhubs/README.md | 109 +++++++++++------- 1 file changed, 66 insertions(+), 43 deletions(-) diff --git a/sdk/eventhubs/microsoft-azure-eventhubs/README.md b/sdk/eventhubs/microsoft-azure-eventhubs/README.md index c0be3ab88d38..95b9c61dbed2 100644 --- a/sdk/eventhubs/microsoft-azure-eventhubs/README.md +++ b/sdk/eventhubs/microsoft-azure-eventhubs/README.md @@ -1,31 +1,41 @@ -

- Microsoft Azure Event Hubs -

+ +# Azure Event Hubs (Track 1) client library for Java

Microsoft Azure Event Hubs Client for Java -

- - star our repo - - follow on Twitter -

-|Branch|Status| -|------|-------------| -|master|[![Build status](https://ci.appveyor.com/api/projects/status/dq8qyu2k3wu2uexd/branch/master?svg=true)](https://ci.appveyor.com/project/sabeegrewal/azure-event-hubs-java/branch/master)| -|dev|[![Build status](https://ci.appveyor.com/api/projects/status/dq8qyu2k3wu2uexd/branch/dev?svg=true)](https://ci.appveyor.com/project/sabeegrewal/azure-event-hubs-java/branch/dev)| +Azure Event Hubs is a hyper-scale data ingestion service, fully-managed by Microsoft, that enables you to collect, store +and process trillions of events from websites, apps, IoT devices, and any stream of data. -Azure Event Hubs is a hyper-scale data ingestion service, fully-managed by Microsoft, that enables you to collect, store and process trillions of events from websites, apps, IoT devices, and any stream of data. +Refer to the [online documentation](https://azure.microsoft.com/services/event-hubs/) to learn more about Event Hubs in +general and for an overview of Event Hubs Client for Java. -Refer to the [online documentation](https://azure.microsoft.com/services/event-hubs/) to learn more about Event Hubs in general and [General Overview document](Overview.md) for an overview of Event Hubs Client for Java. +## Getting started -## Using the library +## Key concepts -### Samples +- An **Event Hub producer** is a source of telemetry data, diagnostics information, usage logs, or other log data, as + part of an embedded device solution, a mobile device application, a game title running on a console or other device, + some client or server based business solution, or a web site. -Code samples are [here](https://github.com/Azure/azure-event-hubs/tree/master/samples/Java). +- An **Event Hub consumer** picks up such information from the Event Hub and processes it. Processing may involve + aggregation, complex computation, and filtering. Processing may also involve distribution or storage of the + information in a raw or transformed fashion. Event Hub consumers are often robust and high-scale platform + infrastructure parts with built-in analytics capabilities, like Azure Stream Analytics, Apache Spark, or Apache Storm. + +- A **partition** is an ordered sequence of events that is held in an Event Hub. Azure Event Hubs provides message + streaming through a partitioned consumer pattern in which each consumer only reads a specific subset, or partition, of + the message stream. As newer events arrive, they are added to the end of this sequence. The number of partitions is + specified at the time an Event Hub is created and cannot be changed. + +- A **consumer group** is a view of an entire Event Hub. Consumer groups enable multiple consuming applications to each + have a separate view of the event stream, and to read the stream independently at their own pace and from their own + position. There can be at most 5 concurrent readers on a partition per consumer group; however it is recommended that + there is only one active consumer for a given partition and consumer group pairing. Each active reader receives all of + the events from its partition; if there are multiple readers on the same partition, then they will receive duplicate + events. + +For more concepts and deeper discussion, see: [Event Hubs Features][event_hubs_features]. Also, the concepts for AMQP +are well documented in [OASIS Advanced Messaging Queuing Protocol (AMQP) Version 1.0][oasis_amqp_v1]. ### Referencing the library @@ -65,26 +75,37 @@ It pulls the required versions of Event Hubs, Azure Storage and GSon libraries. ``` -## How to provide feedback +### How to provide feedback + +First, if you experience any issues with the runtime behavior of the Azure Event Hubs service, please consider filing a +support request right away. Your options for [getting support are enumerated +here](https://azure.microsoft.com/support/options/). In the Azure portal, you can file a support request from the "Help +and support" menu in the upper right hand corner of the page. + +If you find issues in this library or have suggestions for improvement of code or documentation, you can [file an issue +in the project's GitHub repository](https://github.com/Azure/azure-sdk-for-java/issues) or send across a pull request - +see our [Contribution Guidelines](../azure-messaging-eventhubs/CONTRIBUTING.md). -First, if you experience any issues with the runtime behavior of the Azure Event Hubs service, please consider filing a support request -right away. Your options for [getting support are enumerated here](https://azure.microsoft.com/support/options/). In the Azure portal, -you can file a support request from the "Help and support" menu in the upper right hand corner of the page. +Issues related to runtime behavior of the service, such as sporadic exceptions or apparent service-side performance or +reliability issues can not be handled here. -If you find issues in this library or have suggestions for improvement of code or documentation, you can [file an issue in the project's -GitHub repository](https://github.com/Azure/azure-event-hubs/issues) or send across a pull request - see our [Contribution Guidelines](./.github/CONTRIBUTING.md). +Generally, if you want to discuss Azure Event Hubs or this client library with the community and the maintainers, you +can turn to [stackoverflow.com under the #azure-eventhub tag](http://stackoverflow.com/questions/tagged/azure-eventhub) +or the [MSDN Service Bus Forum](https://social.msdn.microsoft.com/Forums/en-US/home?forum=servbus). -Issues related to runtime behavior of the service, such as sporadic exceptions or apparent service-side performance or reliability issues can not be handled here. +## Examples -Generally, if you want to discuss Azure Event Hubs or this client library with the community and the maintainers, you can turn to -[stackoverflow.com under the #azure-eventhub tag](http://stackoverflow.com/questions/tagged/azure-eventhub) or the -[MSDN Service Bus Forum](https://social.msdn.microsoft.com/Forums/en-US/home?forum=servbus). +Code samples are [here](https://github.com/Azure/azure-event-hubs/tree/master/samples/Java). + +## Troubleshooting -## Build & contribute to the library +## Next steps -You will generally not have to build this client library yourself - this library is available on maven central. -If you have any specific requirement for which you want to contribute or need to generate a SNAPSHOT version, this section is for you. -**Your contributions are welcome and encouraged!** +## Contributing + +You will generally not have to build this client library yourself - this library is available on maven central. If you +have any specific requirement for which you want to contribute or need to generate a SNAPSHOT version, this section is +**for** you. **Your contributions are welcome and encouraged!** We adopted maven build model and strive to keep the project model intuitive enough to developers. If you need any help with any specific IDE or cannot get the build going in any environment - please open an issue. @@ -94,14 +115,16 @@ Here are few general topics, which we thought developers would need help with: Set the following two Environment variables to be able to run unit tests targeting Microsoft Azure EventHubs service: - * EVENT_HUB_CONNECTION_STRING - the event hub connection string to which the tests should target. the format of the connection string is: `Endpoint=----NAMESPACE_ENDPOINT------;EntityPath=----EVENTHUB_NAME----;SharedAccessKeyName=----KEY_NAME----;SharedAccessKey=----KEY_VALUE----`. [Here's how to create an Event Hub on Azure Portal and get the connection string](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create). - - * EPHTESTSTORAGE - the Microsoft Azure Storage account connection string to use while running EPH tests. The format of the connection string is: `DefaultEndpointsProtocol=https;AccountName=---STORAGE_ACCOUNT_NAME---;AccountKey=---ACCOUNT_KEY---;EndpointSuffix=---ENPOINT_SUFFIX---`. For more details on this visit - [how to create an Azure Storage account connection string](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-azure-storage-account). - -### Explore the client library with IDEs - -* If you see any Build Errors - make sure the Execution Environment is set to JDK version 1.8 or higher - +* EVENT_HUB_CONNECTION_STRING - the event hub connection string to which the tests should target. the format of the + connection string is: + `Endpoint=----NAMESPACE_ENDPOINT------;EntityPath=----EVENTHUB_NAME----;SharedAccessKeyName=----KEY_NAME----;SharedAccessKey=----KEY_VALUE----`. + [Here's how to create an Event Hub on Azure Portal and get the connection + string](https://docs.microsoft.com/azure/event-hubs/event-hubs-create). +* EPHTESTSTORAGE - the Microsoft Azure Storage account connection string to use while running EPH tests. The format of + the connection string is: + `DefaultEndpointsProtocol=https;AccountName=---STORAGE_ACCOUNT_NAME---;AccountKey=---ACCOUNT_KEY---;EndpointSuffix=---ENPOINT_SUFFIX---`. + For more details on this visit - [how to create an Azure Storage account connection + string](https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-azure-storage-account). -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Feventhubs%2FREADME.png) +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Feventhubs%2Fmicrosoft-azure-eventhubs%2FREADME.png)