Exports the current time as Prometheus metrics. Additional metrics may be exported by providing a configuration file.
This may seem like a useless exporter, but the ideal is to use it for alerting.
I couldn't find an easy way to only alert during a specific time range, so I made a solution.
To run download the jar and run:
java -jar time-range-exporter-1.0.0.jar
Metrics will now be accessible at http://localhost:8080/metrics
jin-java is used for condition evaluation
The following variables are available.
Some metrics are exported by default in camel case format with the prefix name prepended.
For example time_range_hour
| Name | Description | Metric Name |
|---|---|---|
| system | contains all the values from System.getProperties() |
|
| environment | contains all the values from System.getenv() |
|
| metric | contains the properties from the current metric definition | |
| now | A joda-time DateTime object. Any of the methods from the object may be accessed for metric values. For example now.getDayOfYear() |
|
| time | Current time in format HHmmss. | current_time |
| hour | Current hour of day. | current_hour |
| minute | Current minute of hour. | current_minute |
| second | Current second of minute. | current_second |
| week | Current week of year. | current_week |
| month | Current month of year. | current_month |
| year | Current year. | current_year |
| weekOfMonth | Current week of the month. | current_week_of_month |
| dayOfMonth | Current day of the month. | current_day_of_month |
| dayOfWeek | Current day of the week. | current_day_of_week |
| dayOfYear | Current day of the year. | current_day_of_year |
| nameOfDay | A string value for the current day | |
| nameOfMonth | A string value for the current month | |
| daysInMonth | A HashMap of total number of days in month to month name. For instance ['January':'4']. | days_in_month_total{month} |
| weekdaysInMonth | A HashMap of total number of same weekday name to weekday name and month name. For instance {'January':{'Monday':4}}. | weekdays_in_month_total{month,day} |
| daysInCurrentMonth | Total number of days in the current month. | days_in_current_month |
| currentWeekdayNumberInMonth | The current number of this weekday in the month. For instance 3 for the third Monday of the month. | current_weekday_number_in_month |
Additionally the following holidays are also exported as is_holiday{holiday}
| Holiday | Metric Value |
|---|---|
| New Years Day | dayOfYear == 1 |
| Martin Luther King Day | month == 1 and nameOfDay == 'Monday' and currentWeekdayNumberInMonth == 3 |
| Memorial Day | month == 5 and nameOfDay == 'Monday' and currentWeekdayNumberInMonth == weekdaysInMonth[nameOfMonth][nameOfDay] |
| Independence Day | month == 7 and dayOfMonth == 4 |
| Labor Day | month == 9 and nameOfDay == 'Monday' and currentWeekdayNumberInMonth == 1 |
| Thanksgiving | month == 11 and nameOfDay == 'Thursday' and currentWeekdayNumberInMonth == 4 |
| Christmas | month == 12 and dayOfMonth == 25 |
mvn package to build.
Configuration is optional and may be used to add additional metrics.
The configuration is in YAML syntax.
May be specified with the -c command line option, time.prometheus.exporter.config system property, or TIME_EXPORTER_CONFIG environment variable
Config file is monitored for updates dynamically.
Example config:
port: 8080
prefix: "time_range_"
metrics:
- name: callcenter_open
help: help text here
value: "hour > 9 and hour < 21"
labels:
label: value
- name: year_of_century
help: Year of the current century
value: "now.getYearOfCentury()"| Name | Description |
|---|---|
| port | Port to listen on. Command line argument will override. Defaults to 8080 |
| prefix | Prefix name for metrics. Defaults to time_range_ |
| metrics | A list of metrics to export. If the same name is specified for multiple metrics, labels will be merged, and the first set of help will be used |
| name | Name for metric. Prefix will be prepended |
| help | Help text for metric. Defaults to empty |
| value | Value to use for the metric. If true is returned, value will be set to 1. If false is returned, value will be set to 0. If a valid number is returned, value will be set to that number. |
| labels | Labels to set for metric |
- Cody Moore [email protected]
Apache 2.0