Instances are available under server through the instance property
server/instanceAll instances have the following properties:
| Name | Description | Return type | Typical values | Extra |
|---|---|---|---|---|
| name | The given name of the instance | String | My Dev Instance | |
| displayname | The given name of the instance as an Entity | Entity | My Dev Instance | |
| databasetype | The database type of the instance | String | oracle, sqlserver, … | |
| host | The hostip/name that was supplied when registering this instance | String | 10.0.0.83, localhost, .. | |
| hostip | The IP address of this instance | String | 10.0.0.46 | |
| hostname | The host name of this instance, fallback to host if the name is not resolvable | String | test1.mydomain.com | |
| port | The port dbWatch uses to connect to this instance | Number | 1433, 1521, 3306, … | |
| status | The current status for this instance | Entity | OK, ALARM, WARNING, LOST CONNECTION, … | |
| statusnumber | The current status for this instance as a number | Number | 1, 2, 4, … | |
| statustime | The time that the instance got its current status, as milliseconds since 1970 | Number | 1696935522503 | |
| enginetype | The engine types defined for this instance (currently sql and ssh) | List of String | sql, ssh | |
| hasengine | YES/NO value indicating if this instance has a dbwatch engine framework. | String | YES/NO | |
| engine | The name of the database/schema, if any, where the dbwatch engine framework is stored | String | dbwatch | |
| engineuser | The user dbWatch uses (if any) to connect to this instance to run engine procedures. | String | dbwatch | |
| propuser | The user dbWatch uses to connect to this instance in order to resolve dynamic properties. | String | sa, sys | |
| group | The group this instance is a part of | String | Development, Production, … | |
| subgroup | The sugroup this instance is a part of (if any) | String | Project A | |
| connected | Value indicating if dbWatch currently has a valid connection to this instance | String | true, false | |
| unacknowledged | Value indicating if this instance has jobs with unacknowledged warning/alarms | String | true, false | |
| flush | Flushes the cache (on the dbWatch Server) for this instance | String | Flushed instance | |
| driver | The jdbc driver that is used to connect to this instance | Entity | com.microsoft.sqlserver:mssql-jdbc:10.2.0.jre8 | |
| task | A list of all the dbWatch jobs that are installed on this instance | List of Entities | Query cache hitrate, Thread cache hitrate, … | |
| installabletask | A list of all engine jobs that are compatible with this instance | List of Entities | Transaction log size check, Transactions load, … | |
| installableproperty | A list of all non engine jobs that are compatible with this instance | List of Entities | instance_restart_alert, instance_connection_alert, … | |
| installable | A list of all jobs (engine and non engine) that are compatible with this instance | List of Entities | Transactions load, instance_connection_alert, … | |
| pause | If this instance currently has a monitoring pause | String | YES, NO | |
| alerting | If this instance currently has an alerting pause | String | YES, NO | |
| propauthtest | Performs a test connection to the instance using the defined property authentication | String | OK, No Auth, Connection to 10.0.1.192:5432 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections. | |
| monauthtest | Performs a test connection to the instance using the defined monitoring engine authentication (if any) | String | OK, No Auth, Connection to 10.0.1.192:5432 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections. |
In addition most instances have the following properties:
| Name | Description | Return type | Typical values | Extra |
|---|---|---|---|---|
| platform_info | Platform and version info | Entity | Oracle 19.3.0.0.0, SQL Server 2016 (SP3) | |
| edition | The edition of the instance | Entity | Standard Edition, Enterprise Edition | |
| started | A text representation of the start time for the instance | Entity | 21.10.2020 11:39:16, 11.10.2023 11:47:08 | |
| total_session_count | The total number of sessions on the instance | Entity | 12, 432 | |
| disk_usage | The approximate disk usage (in GB) for the instance | Entity | 445 | |
| memory_usage | The approximate memory usage (in MB) for the instance | Entity | 2450 | |
| db_count | The number of databases on the instance | Entity | 23 |
Post your comment on this topic.