emit_macros 1.20.1

Internal proc macro crate for emit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Syntax

```text
(control_param),*
```

where

- `control_param`: A Rust field-value with a pre-determined identifier (see below).

# Control parameters

This macro accepts the following optional control parameters:

| name                                                  | type                    | description                                                                                                                              |
|-------------------------------------------------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `mdl`                                                 | `impl Into<emit::Path>` | The module the metric sample belongs to. If unspecified the current module path is used.                                                 |
| `extent`                                              | `impl emit::ToExtent`   | The extent to use on the metric sample. If unspecified the extent is left empty.                                                         |
| `props`                                               | `impl emit::Props`      | A set of properties to add to the metric sample.                                                                                         |
| `value` (**required**)                                | `impl emit::ToValue`    | The value of the metric sample. If the value is an identifier then `name` will be inferred to be that identifier.                        |
| `name` (**required** if `value` is not an identifier) | `impl emit::ToStr`      | The name of the metric being sampled. If unspecified, and `value` is an identifier, then the stringified identifier is used as the name. |
| `agg`                                                 | `impl emit::ToStr`      | The aggregation of the metric sample. If unspecified, the default for the macro is used.                                                 |

# Returns

An `emit::Metric`.