Configuration
Before using the Data Collector, you need to configure it with your MSM server connection details.
Getting Your Configuration Details
Contact your system administrator to obtain:
- MSM server hostname/IP address
- SSH username and password
- Database connection details
- AWS credentials (if applicable)
Configuration File
The application uses a config.yaml file for settings.
Creating the Configuration File
- In the application folder, create a new file named
config.yaml - Copy the template below and fill in your details
Configuration Template
msm:
host: "your-msm-server-hostname"
ssh_port: 22
ssh_user: "your-username"
ssh_password: "your-password"
postgres_host: "localhost"
postgres_port: 5432
postgres_user: "postgres"
postgres_password: "database-password"
postgres_db: "msmdb"
table_name: "brief_controller_telemetry"
timestamp_column: "msm_timestamp"
api:
base_url: "https://data-collector.aws.ayk-services.com"
logging:
level: "INFO"
file: "logs/extraction.log"
Configuration Fields Explained
MSM Section
| Field | Description | Example |
|---|---|---|
host |
MSM server hostname or IP | msm-server.company.com |
ssh_port |
SSH port (usually 22) | 22 |
ssh_user |
Your SSH username | admin |
ssh_password |
Your SSH password | SecurePass123 |
postgres_host |
Database host (usually localhost) | localhost |
postgres_port |
Database port (usually 5432) | 5432 |
postgres_user |
Database username | postgres |
postgres_password |
Database password | dbPass456 |
postgres_db |
Database name | msmdb |
table_name |
Data table name | brief_controller_telemetry |
timestamp_column |
Timestamp field name | msm_timestamp |
API Section
| Field | Description |
|---|---|
base_url |
Cloud platform URL (provided by administrator) |
Logging Section
| Field | Description |
|---|---|
level |
Log detail level (INFO recommended) |
file |
Where to save logs |
Security Notice
The config.yaml file contains sensitive passwords. Keep it secure and never share it with unauthorized users.
Verifying Configuration
After creating your config.yaml file:
- Save the file in the application root folder
- Proceed to Starting the Application
Configuration Tips
Keep a Backup
Save a copy of your config.yaml file in a secure location. You'll need it if you reinstall the application.
Test Configuration
Ask your administrator about test credentials to verify your setup before using production data.