# service-metrics-release

**Repository Path**: mirrors_cloudfoundry/service-metrics-release

## Basic Information

- **Project Name**: service-metrics-release
- **Description**: Service Metrics BOSH Release 
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Deprecated

This release is deprecated and we do not recomend using it. Instead please
expose a prometheus metrics exposition endpoint and use [prom
scraper](https://github.com/cloudfoundry/loggregator-agent-release/blob/main/docs/prom-scraper.md)
to scrape that endpoint.

# service-metrics-release

Sevice Metrics is a framework for easily sending metrics to
[Cloud Foundry's Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html)
system.

If you have any questions, or want to get attention for a PR or issue please reach out on the [#logging-and-metrics channel in the cloudfoundry slack](https://cloudfoundry.slack.com/archives/CUW93AF3M)

## User Documentation

User documentation can be found
[here](https://docs.pivotal.io/svc-sdk/service-metrics). Documentation is
targeted at service authors wishing to send metrics from their service and
operators wanting to configure service metrics.

## BOSH Release Artifacts

Service Metrics releases artifacts can be found on
[bosh.io](https://bosh.io/releases/github.com/cloudfoundry/service-metrics-release).
Service Metrics 1.5.6+ are licensed under Apache 2.0.

## Running local tests

1. `cd src/`
1. `./scripts/run-tests.sh`

## Deploying Service Metrics

1. Deploy this release with Loggregator components using a manifest similar to
   the one in `manifests/example_manifest.yml`. The example has comments to
   describe the necessary changes to variables.
1. See metrics with `cf tail` and `cf log-stream`. There should be a metric
   named `service_dummy` with a value of 99.