Prepare for 1.5.1 (#142)

* 1.5.1 release

---------

Signed-off-by: Mark Nelson <[email protected]>

Author: markxnelson

Diff for: Dockerfile

@@ -1,54 +1,64 @@
 ARG BASE_IMAGE
-FROM ${BASE_IMAGE} AS build
+FROM ${BASE_IMAGE:-ghcr.io/oracle/oraclelinux:8-slim} AS build
 
 ARG GOOS
-ENV GOOS ${GOOS:-linux}
+ENV GOOS=${GOOS:-linux}
 
 ARG GOARCH
-ENV GOARCH ${GOARCH:-amd64}
+ENV GOARCH=${GOARCH:-amd64}
 
 RUN microdnf install wget gzip gcc && \
     wget -q https://go.dev/dl/go1.22.7.${GOOS}-${GOARCH}.tar.gz && \
     rm -rf /usr/local/go && \
     tar -C /usr/local -xzf go1.22.7.${GOOS}-${GOARCH}.tar.gz && \
     rm go1.22.7.${GOOS}-${GOARCH}.tar.gz
 
-ENV PATH $PATH:/usr/local/go/bin
+ENV PATH=$PATH:/usr/local/go/bin
 
 WORKDIR /go/src/oracledb_exporter
 COPY . .
 RUN go get -d -v
 
 ARG VERSION
-ENV VERSION ${VERSION:-1.0.0}
+ENV VERSION=${VERSION:-1.0.0}
 
 RUN CGO_ENABLED=1 GOOS=${GOOS} GOARCH=${GOARCH} go build -v -ldflags "-X main.Version=${VERSION} -s -w"
 
-FROM ${BASE_IMAGE} as exporter
+FROM ${BASE_IMAGE:-ghcr.io/oracle/oraclelinux:8-slim} AS exporter
 LABEL org.opencontainers.image.authors="Oracle America, Inc."
 LABEL org.opencontainers.image.description="Oracle Database Observability Exporter"
 
-ENV VERSION ${VERSION:-1.0.0}
+ARG VERSION
+ENV VERSION=${VERSION:-1.0.0}
 ENV DEBIAN_FRONTEND=noninteractive
 
+ARG GOARCH
+ENV GOARCH=${GOARCH:-amd64}
+
+# note: the 23ai arm drivers are not in yum yet, when they are can switch this to just use yum and not need
+# to wget the driver for arm.  also note that the permalink for otn download of drivers does not have version
+# in it, and does not appear to be a link vith version in it, so that link is very brittle and could break build
 RUN if [ "$GOARCH" = "amd64" ]; then \
-      microdnf install -y oracle-instantclient-release-el8 && microdnf install -y oracle-instantclient-basic && \
+      microdnf install -y oracle-instantclient-release-23ai-el8 && microdnf install -y oracle-instantclient-basic && \
       microdnf install glibc-2.28-251.0.2.el8_10.4 \
     ; else \
-      microdnf install oracle-release-el8 && \
-      microdnf install -y oracle-instantclient19.23-basic && \
+      microdnf install wget libaio && \
+      wget https://download.oracle.com/otn_software/linux/instantclient/instantclient-basic-linux-arm64.rpm && \
+      rpm -ivh instantclient-basic-linux-arm64.rpm && \
+      ln -s /usr/lib/oracle/19.24 /usr/lib/oracle/23 && \
       microdnf install glibc-2.28-251.0.2.el8_10.4 \
     ; fi
 
-ENV LD_LIBRARY_PATH /usr/lib/oracle/21/client64/lib
-ENV PATH $PATH:/usr/lib/oracle/21/client64/bin
-ENV ORACLE_HOME /usr/lib/oracle/21/client64
+ENV LD_LIBRARY_PATH=/usr/lib/oracle/23/client64/lib:usr/lib/oracle/19.24/client64/lib
+ENV PATH=$PATH:/usr/lib/oracle/23/client64/bin:usr/lib/oracle/19.24/client64/bin
+ENV ORACLE_HOME=/usr/lib/oracle/23/client64
 
 COPY --from=build /go/src/oracledb_exporter/oracle-db-appdev-monitoring /oracledb_exporter
 ADD ./default-metrics.toml /default-metrics.toml
 
 # create the mount point for alert log exports (default location)
 RUN mkdir /log && chown 1000:1000 /log
+RUN mkdir /wallet && chown 1000:1000 /wallet
 
 EXPOSE 9161
 

Diff for: Makefile

@@ -3,7 +3,7 @@ OS_TYPE        ?= $(shell uname -s | tr '[:upper:]' '[:lower:]')
 ARCH_TYPE      ?= $(subst x86_64,amd64,$(patsubst i%86,386,$(ARCH)))
 GOOS           ?= $(shell go env GOOS)
 GOARCH         ?= $(shell go env GOARCH)
-VERSION        ?= 1.5.0
+VERSION        ?= 1.5.1
 LDFLAGS        := -X main.Version=$(VERSION)
 GOFLAGS        := -ldflags "$(LDFLAGS) -s -w"
 BUILD_ARGS      = --build-arg VERSION=$(VERSION)
@@ -83,10 +83,10 @@ push-images:
 	@make --no-print-directory push-oraclelinux-image
 
 docker:
-	docker build --no-cache --progress=plain $(BUILD_ARGS) -t "$(IMAGE_ID)" --build-arg BASE_IMAGE=$(ORACLE_LINUX_BASE_IMAGE) . 
+	docker build --no-cache --progress=plain $(BUILD_ARGS) -t "$(IMAGE_ID)-amd64" --build-arg BASE_IMAGE=$(ORACLE_LINUX_BASE_IMAGE) --build-arg GOARCH=amd64 . 
 
 docker-arm:
-	docker build --no-cache --progress=plain $(BUILD_ARGS) -t "$(IMAGE_ID)" --build-arg BASE_IMAGE=$(ORACLE_LINUX_BASE_IMAGE) --build-arg GOARCH=arm64 . 
+	docker buildx build --platform linux/arm64 --load --no-cache --progress=plain $(BUILD_ARGS) -t "$(IMAGE_ID)-arm64" --build-arg BASE_IMAGE=$(ORACLE_LINUX_BASE_IMAGE) --build-arg GOARCH=arm64 . 
 
 push-oraclelinux-image:
 	docker push $(IMAGE_ID)

Diff for: README.md

@@ -27,6 +27,17 @@ Contributions are welcome - please see [contributing](CONTRIBUTING.md).
 
 ## Release Notes
 
+### Version 1.5.1, October 28, 2024
+
+This release includes the following changes:
+
+- Added support for using the `TNS_ADMIN` environment variable, which fixes an issue when connecting to Autonomous Database instances using TNS name.
+- Updated InstantClient to 23ai version for amd64 and latest available 19.24 version for arm64.
+- Fixed an issue with wrong `LD_LIBRARY_PATH` on some platforms. (#136)
+- Added documentation and an example of using the `scrapeinterval` setting to change the interval at which a certain metric is colected.
+- Added notes to documentation for extra security parameters needed when using a wallet with Podman.
+- Updated some third-party dependencies.
+
 ### Version 1.5.0, September 26, 2024
 
 This release includes the following changes:
@@ -333,6 +344,11 @@ oracledb_wait_time_system_io 1.62
 oracledb_wait_time_user_io 24.5
 ```
 
+These standard metrics are defined in the file `default-metrics.toml` found in the root directory of this repository. 
+
+> **Note:** You can change the interval at which metrics are collected at a per-metric level.  If you find that any of the default metrics are placing too much load on your database instance, you may will too collect that particular metric less often, which can be done by adding the `scrapeinterval` paraemeter to the metric definition.  See the definition of the `top_sql` metric for an example.
+
+
 ## Database permissions required
 
 For the built-in default metrics, the database user that the exporter uses to connect to the Oracle Database instance must have the `SELECT_CATALOG_ROLE` privilege and/or `SELECT` permission on the following objects:
@@ -459,7 +475,7 @@ docker run -it --rm \
     -e DB_PASSWORD=Welcome12345 \
     -e DB_CONNECT_STRING=free23ai:1521/freepdb \
     -p 9161:9161 \
-    container-registry.oracle.com/database/observability-exporter:1.5.0
+    container-registry.oracle.com/database/observability-exporter:1.5.1
 ```
 
 ##### Using a wallet
@@ -477,6 +493,9 @@ Now, you provide the connection details using these variables:
 - `DB_CONNECT_STRING` is the connection string, e.g., `devdb_tp?TNS_ADMIN=/wallet`
 - `DB_ROLE` (Optional) can be set to `SYSDBA` or `SYSOPER` if you want to connect with one of those roles, however Oracle recommends that you connect with the lowest possible privileges and roles necessary for the exporter to run.
 - `ORACLE_HOME` is the location of the Oracle Instant Client, i.e., `/lib/oracle/21/client64/lib`.  If you built your own container image, the path may be different.
+- `TNS_ADMIN` is the location of your (unzipped) wallet.  The `DIRECTORY` set in the `sqlnet.ora` file must match the path that it will be mounted on inside the container.
+
+> **Note:** Specify the path to your wallet using the `TNS_ADMIN` environment variable rather than adding it to the `DB_CONNECT_STRING`.
 
 To run the exporter in a container and expose the port, use a command like this, with the appropriate values for the environment variables, and mounting your `wallet` directory as `/wallet` in the container to provide access to the wallet:
 
@@ -487,8 +506,9 @@ docker run -it --rm \
     -e DB_CONNECT_STRING=devdb_tp \
     -v ./wallet:/wallet \
     -p 9161:9161 \
-    container-registry.oracle.com/database/observability-exporter:1.5.0
+    container-registry.oracle.com/database/observability-exporter:1.5.1
 ```
+> **Note:** If you are using `podman` you must specify the `:z` suffix on the volume mount so that the container will be able to access the files in the volume.  For example: `-v ./wallet:/wallet:z`
 
 ### Test/demo environment with Docker Compose
 
@@ -651,6 +671,7 @@ You may provide the connection details using these variables:
 - `DB_CONNECT_STRING` is the connection string, e.g., `localhost:1521/freepdb1`
 - `DB_ROLE` (Optional) can be set to `SYSDBA` or `SYSOPER` if you want to connect with one of those roles, however Oracle recommends that you connect with the lowest possible privileges and roles necessary for the exporter to run.
 - `ORACLE_HOME` is the location of the Oracle Instant Client, e.g., `/lib/oracle/21/client64/lib`.  
+- `TNS_ADMIN` is the location of your (unzipped) wallet.  The `DIRECTORY` set in the `sqlnet.ora` file must match the path that it will be mounted on inside the container.
 
 The following example puts the logfile in the current location with the filename `alert.log` and loads the default matrics file (`default-metrics,toml`) from the current location.
 
@@ -775,7 +796,7 @@ An exmaple of [custom metrics for Transacational Event Queues](./custom-metrics-
 If you run the exporter as a container image and want to include your custom metrics in the image itself, you can use the following example `Dockerfile` to create a new image:
 
 ```Dockerfile
-FROM container-registry.oracle.com/database/observability-exporter:1.5.0
+FROM container-registry.oracle.com/database/observability-exporter:1.5.1
 COPY custom-metrics.toml /
 ENTRYPOINT ["/oracledb_exporter", "--custom.metrics", "/custom-metrics.toml"]
 ```

Diff for: collector/collector.go

@@ -35,6 +35,7 @@ type Exporter struct {
 	user            string
 	password        string
 	connectString   string
+	configDir       string
 	duration, error prometheus.Gauge
 	totalScrapes    prometheus.Counter
 	scrapeErrors    *prometheus.CounterVec
@@ -53,6 +54,7 @@ type Config struct {
 	Password           string
 	ConnectString      string
 	DbRole             string
+	ConfigDir          string
 	MaxIdleConns       int
 	MaxOpenConns       int
 	CustomMetrics      string
@@ -114,6 +116,7 @@ func NewExporter(logger log.Logger, cfg *Config) (*Exporter, error) {
 		user:          cfg.User,
 		password:      cfg.Password,
 		connectString: cfg.ConnectString,
+		configDir:     cfg.ConfigDir,
 		duration: prometheus.NewGauge(prometheus.GaugeOpts{
 			Namespace: namespace,
 			Subsystem: exporterName,
@@ -367,6 +370,9 @@ func (e *Exporter) connect() error {
 	var P godror.ConnectionParams
 	P.Username, P.Password, P.ConnectString = e.user, godror.NewPassword(e.password), e.connectString
 
+	// if TNS_ADMIN env var is set, set ConfigDir to that location
+	P.ConfigDir = e.configDir
+
 	if strings.ToUpper(e.config.DbRole) == "SYSDBA" {
 		P.IsSysDBA = true
 	}

Diff for: default-metrics.toml

@@ -95,6 +95,11 @@ order by elapsed_time desc
 ) where ROWNUM <= 15
 '''
 ignorezeroresult = true
+# scrapeinterval = "5m"
+# The previous line is an example of changing the interval at which this one metric
+# will be scraped. You may wish to do this to scrape a metric less often, if the SQL
+# statement to collect that metric places more load on your database instance than 
+# desired when it is run at every scrape.
 
 [[metric]]
 context = "cache_hit_ratio"

Diff for: docker-compose/compose.yaml

@@ -43,7 +43,7 @@ services:
       start_period: 30s
 
   exporter:
-    image: container-registry.oracle.com/database/observability-exporter:1.5.0
+    image: container-registry.oracle.com/database/observability-exporter:1.5.1
     container_name: exporter
     ports:
       - 9161:9161

Diff for: go.mod

@@ -1,18 +1,18 @@
 module github.com/oracle/oracle-db-appdev-monitoring
 
-go 1.21
+go 1.22
 
-toolchain go1.21.4
+toolchain go1.22.4
 
 require (
 	github.com/BurntSushi/toml v1.4.0
 	github.com/alecthomas/kingpin/v2 v2.4.0
 	github.com/go-kit/log v0.2.1
-	github.com/godror/godror v0.44.7
-	github.com/oracle/oci-go-sdk/v65 v65.75.0
-	github.com/prometheus/client_golang v1.20.2
-	github.com/prometheus/common v0.59.1
-	github.com/prometheus/exporter-toolkit v0.11.0
+	github.com/godror/godror v0.44.8
+	github.com/oracle/oci-go-sdk/v65 v65.77.1
+	github.com/prometheus/client_golang v1.20.5
+	github.com/prometheus/common v0.60.1
+	github.com/prometheus/exporter-toolkit v0.12.0
 )
 
 require (
@@ -25,19 +25,21 @@ require (
 	github.com/gofrs/flock v0.8.1 // indirect
 	github.com/jpillora/backoff v1.0.0 // indirect
 	github.com/klauspost/compress v1.17.9 // indirect
+	github.com/mdlayher/socket v0.4.1 // indirect
+	github.com/mdlayher/vsock v1.2.1 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/sony/gobreaker v0.5.0 // indirect
 	github.com/xhit/go-str2duration/v2 v2.1.0 // indirect
-	golang.org/x/crypto v0.26.0 // indirect
+	golang.org/x/crypto v0.27.0 // indirect
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
-	golang.org/x/net v0.28.0 // indirect
-	golang.org/x/oauth2 v0.22.0 // indirect
+	golang.org/x/net v0.29.0 // indirect
+	golang.org/x/oauth2 v0.23.0 // indirect
 	golang.org/x/sync v0.8.0 // indirect
-	golang.org/x/sys v0.23.0 // indirect
-	golang.org/x/text v0.17.0 // indirect
+	golang.org/x/sys v0.25.0 // indirect
+	golang.org/x/text v0.18.0 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 )