This VS Code extension allows you to generate and send random messages to an Azure Event Hub based on the configuration defined in a settings.yml file within your workspace.
Features
Generate Random Messages: Generates random messages for a configurable number of devices.
Azure Event Hub Integration: Send the generated messages to Azure Event Hub.
Customizable Geosection: Supports both "square" and "round" geosection types for location data (optional).
Message Parameters: Define different parameters with min and max values to simulate data for each message.
Progress Reporting: Visual progress is displayed in VS Code during message sending, with a notification when completed.
Environment Variable Support: If the connection string is not defined in the settings.yml file, the extension will use the AZURE_EVENTHUB_CONNECTION_STRING environment variable.
Precision Handling: All float values, including geocoordinates, are explicitly rounded to 5 decimal places for consistency.
Timestamp Parameter: Optionally include a timestamp (UTC).
Parallel Execution: Improved message sending through parallel execution with concurrency control, optimizing performance.
Dynamic Concurrency Limit: The concurrencyLimit parameter in settings.yml allows users to set a custom concurrency limit. By default, the system dynamically adapts based on available CPU cores.
Installation
Clone or download the extension's repository.
Open the extension folder in VS Code.
Press F5 to launch the extension in a new VS Code window.
In the new window, open a workspace and ensure the settings.yml file is placed in the workspace root folder.
Configuration
The extension expects a settings.yml file in the workspace folder. Below is an example of the required configuration:
Example settings.yml
azureEventHub:
connectionString: "Endpoint=sb://<namespace>.servicebus.windows.net/;SharedAccessKeyName=<keyname>;SharedAccessKey=<key>;EntityPath=<hubname>"
startId: 1 # parameter for starting ID, defaults to 1
idKeyName: "deviceId" # Optional. Defaults to 'deviceId' if not provided.
entityCount: 5 # The number of entities to simulate (formerly nmbOfDevices)
delay: 1 # Delay in seconds between messages
maxMessages: 100 # Maximum number of messages to send (default 100)
concurrencyLimit: 10 # Max concurrency limit (optional)
timestamp:
enabled: true # Enable or disable timestamp in messages (default: false)
geosection:
type: square # Geosection type: 'square' or 'round'
center:
lat: 0.0 # Latitude of the center (only for 'round' type)
lon: 0.0 # Longitude of the center (only for 'round' type)
bounds:
radius: 1 # Radius in km (only for 'round' type)
lat_range: [-90.0, 90.0] # Latitude range for 'square' type
lon_range: [-180.0, 180.0] # Longitude range for 'square' type
values:
- name: "Temperature"
min: 0
max: 10
type: "float" # Use "int" for integer values or "float" for decimal values (default: "float")
- name: "Size"
min: 5
max: 15
type: "int"
Parameters Explained:
idKeyName (optional): Specifies the key name for the entity identifier (default is deviceId).
entityCount: Number of devices for which messages will be generated.
delay: Delay in seconds between sending messages.
maxMessages: Total number of messages to be generated and sent (default: 100).
concurrencyLimit: Maximum number of concurrent tasks when sending messages. This value can be set in settings.yml and will optimize performance based on system resources. If not specified, the system adapts to the number of CPU cores available.
geosection: Geographical range of coordinates to be included in the message (optional).
type: Set as square or round. Defines the type of geospatial area.
center: Latitude and longitude of the center for round geosections.
bounds: Bounds of the geosection, which can include radius (for round) or lat/lon ranges (for square).
azureEventHub.connectionString: Azure Event Hub connection string (or set the environment variable AZURE_EVENTHUB_CONNECTION_STRING if not defined in the YAML).
values: List of parameters to be included in each message (e.g., Temperature, Size), with:
name: Parameter name.
min and max: Range of random values.
type: Specifies int or float (default: float). All float values are explicitly rounded to 5 decimal places.
timestamp: Optionally include the timestamp when the message is generated.
enabled: Set to true to include the timestamp in the message (default: false).
Usage
Once the extension is installed and the settings.yml file is configured, open the Command Palette (Ctrl+Shift+P).
Search for Send Messages to Event Hub and select it to start sending messages to your Azure Event Hub.
The extension will generate messages for the defined number of devices and send them to Azure Event Hub. You will see the progress in the notification and status bar.
Logging
Logs will be displayed in the VS Code Developer Console (Ctrl+Shift+I to open the console).
Progress is shown in the status bar during message generation.
If any errors occur (e.g., invalid configuration or connection issues), they will be displayed in the VS Code notifications.
Troubleshooting
No workspace folder open: Ensure you have opened a workspace in VS Code before using the extension.
Missing settings.yml file: Ensure the settings.yml file exists in the root of your workspace.
Missing Azure Event Hub connection string: If the connection string is not defined in the settings.yml file, set the AZURE_EVENTHUB_CONNECTION_STRING environment variable.
Known Limitations
Port 5671 Connectivity
This application uses Azure Event Hubs, which relies on AMQP protocol over port 5671 for communication. If the application fails to connect to the Event Hub, it could be due to network restrictions blocking this port.
How to Test
Open a terminal and run the following command to check if port 5671 is accessible:
telnet <namespace>.servicebus.windows.net 5671
Contributing
Fork the repository.
Make your changes and submit a pull request.
Ensure that all code is tested before submitting a PR.
License
This project is licensed under the MIT License - see the LICENSE file for details.
