Skip to content

Commit c30db92

Browse files
update README
1 parent 3b2a937 commit c30db92

File tree

1 file changed

+15
-25
lines changed

1 file changed

+15
-25
lines changed

README.md

+15-25
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33
This is a bespoke Prometheus exporter enabling the monitoring of SAP systems (a.k.a. SAP NetWeaver applications).
44

55
[![Exporter CI](https://github.com/SUSE/sap_host_exporter/workflows/Exporter%20CI/badge.svg)](https://github.com/SUSE/sap_host_exporter/actions?query=workflow%3A%22Exporter+CI%22)
6-
[![Dashboards CI](https://github.com/SUSE/sap_host_exporter/workflows/Dashboards%20CI/badge.svg)](https://github.com/SUSE/sap_host_exporter/actions?query=workflow%3A%22Dashboards+CI%22)
7-
86

97
## Table of Contents
8+
109
1. [Features](#features)
1110
2. [Installation](#installation)
1211
3. [Usage](#usage)
@@ -18,51 +17,48 @@ This is a bespoke Prometheus exporter enabling the monitoring of SAP systems (a.
1817
2. [Development](doc/development.md)
1918
6. [License](#license)
2019

21-
2220
## Features
2321

2422
The exporter is a stateless HTTP endpoint. On each HTTP request, it pulls runtime data from the SAP system via the SAPControl web interface.
2523

2624
Exported data include:
25+
2726
- Start Service processes
2827
- Enqueue Server stats
2928
- AS Dispatcher work process queue stats
3029

31-
3230
## Installation
3331

3432
The project can be installed in many ways, including but not limited to:
3533

36-
1. [Manual clone & build](#manual-clone-&-build)
34+
1. [Manual clone and build](#manual-clone-and-build)
3735
2. [Go](#go)
3836
3. [RPM](#rpm)
3937

38+
### Manual clone and build
4039

41-
### Manual clone & build
42-
43-
```
40+
```shell
4441
git clone https://github.com/SUSE/sap_host_exporter
4542
cd sap_host_exporter
46-
make
43+
make build
4744
make install
4845
```
4946

5047
### Go
5148

52-
```
49+
```shell
5350
go get github.com/SUSE/sap_host_exporter
5451
```
5552

5653
### RPM
57-
You can find the repositories for RPM based distributions in [SUSE's Open Build Service](https://build.opensuse.org/package/show/server:monitoring/prometheus-sap_host_exporter).
54+
55+
You can find the repositories for RPM based distributions in [SUSE's Open Build Service](https://build.opensuse.org/package/show/devel:sap:monitoring:stable/prometheus-sap_host_exporter).
5856
On openSUSE or SUSE Linux Enterprise you can just use the `zypper` system package manager:
57+
5958
```shell
60-
export DISTRO=SLE_15_SP2 # change as desired
61-
zypper addrepo https://download.opensuse.org/repositories/server:/monitoring/$DISTRO/server:monitoring.repo
6259
zypper install prometheus-sap_host_exporter
6360
```
6461

65-
6662
## Usage
6763

6864
You can run the exporter as follows:
@@ -78,12 +74,8 @@ Though not strictly required, it is advised to run the exporter locally in the t
7874
```
7975

8076
For further details on SAPControl, please refer to the [official SAP docs](https://www.sap.com/documents/2016/09/0a40e60d-8b7c-0010-82c7-eda71af511fa.html) to properly connect to the SAPControl service.
81-
82-
The exporter will expose the metrics under the `/metrics` path, on port `9680` by default.
8377

84-
**Hint:**
85-
You can deploy a full SAP NetWeaver cluster via Terraform with [SUSE/ha-sap-terraform-deployments](https://github.com/SUSE/ha-sap-terraform-deployments);
86-
this exporter and the whole Prometheus monitoring stack will be automatically installed and configured for you.
78+
The exporter will expose the metrics under the `/metrics` path, on port `9680` by default.
8779

8880
### Configuration
8981

@@ -114,23 +106,21 @@ A [systemd unit file](packaging/obs/prometheus-sap_host_exporter.spec) is provid
114106
systemctl --now enable prometheus-sap_host_exporter
115107
```
116108

117-
118109
## Contributing
119110

120111
Pull requests are more than welcome!
121112

122113
We recommend having a look at the [design document](doc/design.md) and the [development notes](doc/development.md) before contributing.
123114

115+
## Copying
124116

125-
## License
126-
127-
Copyright 2020 SUSE LLC
117+
Copyright 2020-2025 SUSE LLC
128118

129119
Licensed under the Apache License, Version 2.0 (the "License");
130-
you may not use this file except in compliance with the License.
120+
you may not use this code repository except in compliance with the License.
131121
You may obtain a copy of the License at
132122

133-
https://www.apache.org/licenses/LICENSE-2.0
123+
<https://www.apache.org/licenses/LICENSE-2.0>
134124

135125
Unless required by applicable law or agreed to in writing, software
136126
distributed under the License is distributed on an "AS IS" BASIS,

0 commit comments

Comments
 (0)