v 0.4.1

Signed-off-by: peekjf72 <jfpik78@gmail.com>

Author: peekjef72

CHANGELOG.md

@@ -4,12 +4,77 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog).
 
  <!--next-version-placeholder-->
-## 0.4.1 / 2025-03-30 - not release
+## 0.4.1 / 2025-06-04
+
+- added: new contrib [apache_exporter configuration](./contribs/apache/README.md). a good example to introduce javascript code to build metrics.
+
+### 2025-05-25 - not release
+
+- added: support for env vars in target_config [see issue #1](https://github.com/peekjef72/httpapi_exporter/issues/1) :
+
+e.g.:
+
+```yaml
+targets:
+  - name: my_target
+    scheme: https
+    host: $env:MY_HOST_ENV_VAR_NAME
+    port: 443
+```
+
+### 2025-05-16 - not release
+
+- changed: internal "scope" directive: add error and debug msg.
+- added: new parameter 'collector' to '/metrics' entry point. Collect only the specified collector(s). May be use to collect specific metrics in a particular prometheus job.
+
+### 2025-05-07 - not release
+
+#### BREAKING CHANGE
+
+- renamed: variable `results_code` to `status_code`
+  => update all config profiles !
+- changed: in log line renamed 'collid' to 'coll' and use collector name instead of a sequential number.
+
+### 2025-05-06 - not release
+
+- added: support for `javascript code` in each field, as an alternative to gotemplate. This part is still in development (see examples)
+
+- added: new metric named "query_status" (prefixed by metric_prefix) and labeled by url query stage. The goal is to provide a always generated value for each queried url with the http status code as value. The generation is conditionned by the status attribute from each query action and the default value is false.
+
+```yaml
+  - name: check api url
+    query:
+      url: /api/health
+      method: GET
+      status: true
+      trace: true
+```
+
+will provide:
+
+```text
+# HELP xxx_query_status query http status label by phase(url): http return code
+# TYPE xxx_query_status gauge
+xxx_query_status{phase="/api/health"} 200
+# HELP xxx_query_perf_seconds query stage duration in seconds
+# TYPE xxx_query_perf_seconds gauge
+xxx_query_perf_seconds{page="/status",stage="conn_time"} 0.004550086
+xxx_query_perf_seconds{page="/status",stage="dns_lookup"} 4.3538e-05
+xxx_query_perf_seconds{page="/status",stage="response_time"} 4.5354e-05
+xxx_query_perf_seconds{page="/status",stage="server_time"} 0.000361965
+xxx_query_perf_seconds{page="/status",stage="tcp_con_time"} 0.000111871
+xxx_query_perf_seconds{page="/status",stage="tls_handshake"} 0.004329272
+xxx_query_perf_seconds{page="/status",stage="total_time"} 0.004912388
+
+```
+
+If the request timeouts, the status code is 504.
+If the request is not perfomed (target is down), the status code is 0.
 
 ### 2025-03-26 - not release
 
 - added: global config parameter tls_version that allows to add old tls ciphers, because of golang change since 1.22: see [config](doc/config.md); update the netscaler default config file to use tls_version: all
-- code refactored to use [cast](github.com/spf13/cast) for type conversion in internal functions.
+- code refactored to use [cast](http://github.com/spf13/cast) for type conversion in internal functions.
 - added: scripting language evolution to allow named var into expr : `$var_name.${another_varname[.attr1]}[.attr2]`
 - changed: loglevel trace from warn to debug for metrics not found:
 
@@ -27,7 +92,7 @@ e.g.:
 
   The same behavior is implemented for variables used in `loop` or `with_items` action.
 
-### BREAKING CHANGE
+#### BREAKING CHANGE
 
 - remove feature that allows to set a single text not preceded by $ sign as value for key_labels or values:
 

README.md

@@ -14,12 +14,13 @@ The queried url can return data in several format:
 - raw text (parse as text-lines)
 - prometheus openmetrics
 
-As examples 4 configurations for exporters are provided (see contribs):
+As examples, configurations for exporters are provided (see contribs):
 
 - [hp3par_exporter](contribs/hp3par/README.md)
 - [veeam_exporter](contribs/veeam/README.md)
 - [netscaler_exporter](contribs/netscaler/README.md)
 - [aruba_exporter](contribs/arubacx/README.md)
+- [apache_exporter](contribs/apache/README.md)
 
 # Build
 
@@ -231,39 +232,9 @@ How it works:
         environment: "DEV"
     ```
 
-# custom functions for templating
+# building custom exporter config
 
 (**still incomplete**)
-
-Go template is used to manipulate data. So templates inherits from go functions and [sprig](https://masterminds.github.io/sprig/) v3 functions.
-Because the exporter uses most of the time data of type "any (interface{})" some of the sprig functions failed.
-Here is the list of exporter functions:
-
-name| usage | e.g. |
---|---|---|
-exporterDecryptPass | | |
-exporterGet [varmap] [keyname] | get the keyname from the map. Like sprig/get function but accepts data of type map[any]any | exporterGet .svclb .svc |
-exporterSet | | |
-exporterKeys | | |
-exporterValues | | |
-exporterToRawJson | | |
-&nsbp; | | |
-lookupAddr [varstring] | obtain hostname from string representing an ip address ; like sprig/getHostByName but for string ip | lookupAddr .node.ipaddress |
-convertToBytes value unit | convert the value contained in variable to bytes according to the unit string specified: <ul><li>"kilobyte" or "Kb" multiply by 1024 <li>"megabyte" or "Mb" multiply by 1024 * 1024<li>"gigabyte" or "Gb"multiply by 1024 * 1024 * 1024</ul> | '{{ convertToBytes .result.totalMiB "Mb" }}' |
-convertBoolToInt value | convert value that may contain a boolean to 0&#124;1 representation. Value can be of any type. If something is <ul><li>like int or float and different from 0 is 1 else 0<li>string and is lower case 'true' or 'yes' or 'ok' is 1 else 0<li>like map or array and length >0 then 1 or 0</ul>| with {"proc": {"loopCrashing": "true",...}}<br> => '{{ convertBoolToInt .proc.loopCrashing }}<br> => 1' |
-getHeader [varmap] | | |
-LEN [var] | obtain the len of the var. works like sprig/len but accepts data of type any. | |
-exporterRegexExtract [regexp var] [search var] : []string | obtain the list of extracted elements from regexp on search string or nil if not found | extract value from line as group 1 of regexp: <br> res: "{{ index  (exporterRegexExtract "^status:\s(.+)$" "status:OK") 1 }}" |
-
-## boolean checks
-
-name| usage | e.g. |
----|---|---|
-EQ [var1] [var2] | check equality for 2 variables; accepts any type of data; meaning that the second will be converted to the type of the first | EQ .val "2" |
-NE [var1] [var2] | not equal | NE 2 .val |
-GE [var1] [var2] | greater equal | |
-GT [var1] [var2] | greater than | |
-LE [var1] [var2] | less equal | |
-LT [var1] [var2] | less than | |
-exists [var1] | return boolean if variable exists| exists .config.cluster.node |
-exporterHasKey [var] [key] | check if variable is a map and has a key | exporterHasKey .config "cluster" |
+. see [up/metrics schema](./doc/session.png)
+. see [actions](./doc/actions.md)
+. see [template/functions](./doc/custom_functions.md)

actions_action.go

@@ -13,13 +13,13 @@ import (
 // ***************************************************************************************
 
 type ActionsAction struct {
-	Name    *Field              `yaml:"name,omitempty" json:"name,omitempty"`
-	With    []any               `yaml:"with,omitempty" json:"with,omitempty"`
-	When    []*exporterTemplate `yaml:"when,omitempty" json:"when,omitempty"`
-	LoopVar string              `yaml:"loop_var,omitempty" json:"loop_var,omitempty"`
-	Vars    map[string]any      `yaml:"vars,omitempty" json:"vars,omitempty"`
-	Until   []*exporterTemplate `yaml:"until,omitempty" json:"until,omitempty"`
-	Actions []Action            `yaml:"actions,omitempty" json:"actions,omitempty"`
+	Name    *Field         `yaml:"name,omitempty" json:"name,omitempty"`
+	With    []any          `yaml:"with,omitempty" json:"with,omitempty"`
+	When    []*Field       `yaml:"when,omitempty" json:"when,omitempty"`
+	LoopVar string         `yaml:"loop_var,omitempty" json:"loop_var,omitempty"`
+	Vars    map[string]any `yaml:"vars,omitempty" json:"vars,omitempty"`
+	Until   []*Field       `yaml:"until,omitempty" json:"until,omitempty"`
+	Actions []Action       `yaml:"actions,omitempty" json:"actions,omitempty"`
 
 	vars [][]any
 
@@ -32,11 +32,11 @@ func (a *ActionsAction) Type() int {
 }
 
 func (a *ActionsAction) GetName(symtab map[string]any, logger *slog.Logger) string {
-	str, err := a.Name.GetValueString(symtab)
+	str, err := a.Name.GetValueString(symtab, logger)
 	if err != nil {
 		logger.Warn(
 			fmt.Sprintf("invalid action name: %v", err),
-			"collid", CollectorId(symtab, logger),
+			"coll", CollectorId(symtab, logger),
 			"script", ScriptName(symtab, logger))
 		return ""
 	}
@@ -57,11 +57,11 @@ func (a *ActionsAction) SetWidth(with []any) {
 	a.With = with
 }
 
-func (a *ActionsAction) GetWhen() []*exporterTemplate {
+func (a *ActionsAction) GetWhen() []*Field {
 	return a.When
 
 }
-func (a *ActionsAction) SetWhen(when []*exporterTemplate) {
+func (a *ActionsAction) SetWhen(when []*Field) {
 	a.When = when
 }
 
@@ -79,10 +79,10 @@ func (a *ActionsAction) SetVars(vars [][]any) {
 	a.vars = vars
 }
 
-func (a *ActionsAction) GetUntil() []*exporterTemplate {
+func (a *ActionsAction) GetUntil() []*Field {
 	return a.Until
 }
-func (a *ActionsAction) SetUntil(until []*exporterTemplate) {
+func (a *ActionsAction) SetUntil(until []*Field) {
 	a.Until = until
 }
 
@@ -95,8 +95,8 @@ func (a *ActionsAction) setBasicElement(
 	vars [][]any,
 	with []any,
 	loopVar string,
-	when []*exporterTemplate,
-	until []*exporterTemplate) error {
+	when []*Field,
+	until []*Field) error {
 	return setBasicElement(a, nameField, vars, with, loopVar, when, until)
 }
 
@@ -141,7 +141,7 @@ func (a *ActionsAction) SetPlayAction(script map[string]*YAMLScript) error {
 func (a *ActionsAction) CustomAction(script *YAMLScript, symtab map[string]any, logger *slog.Logger) error {
 	logger.Debug(
 		fmt.Sprintf("[Type: ActionsAction] - %d Actions to play", len(a.Actions)),
-		"collid", CollectorId(symtab, logger),
+		"coll", CollectorId(symtab, logger),
 		"script", ScriptName(symtab, logger),
 		"name", a.GetName(symtab, logger))
 	for _, cur_act := range a.Actions {