Docs Packages
  1. Pulumi Registry
  2. Grafana Cloud
  3. API Docs
  4. SyntheticMonitoringProbe
grafana logo
Grafana v0.0.10, May 21 23

grafana.SyntheticMonitoringProbe

Explore with Pulumi AI

Besides the public probes run by Grafana Labs, you can also install your own private probes. These are only accessible to you and only write data to your Grafana Cloud account. Private probes are instances of the open source Grafana Synthetic Monitoring Agent.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Lbrlabs.PulumiPackage.Grafana;

return await Deployment.RunAsync(() => 
{
    var main = new Grafana.SyntheticMonitoringProbe("main", new()
    {
        Labels = 
        {
            { "type", "mountain" },
        },
        Latitude = 27.98606,
        Longitude = 86.92262,
        Region = "APAC",
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-grafana/sdk/go/grafana"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := grafana.NewSyntheticMonitoringProbe(ctx, "main", &grafana.SyntheticMonitoringProbeArgs{
			Labels: pulumi.StringMap{
				"type": pulumi.String("mountain"),
			},
			Latitude:  pulumi.Float64(27.98606),
			Longitude: pulumi.Float64(86.92262),
			Region:    pulumi.String("APAC"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.SyntheticMonitoringProbe;
import com.pulumi.grafana.SyntheticMonitoringProbeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var main = new SyntheticMonitoringProbe("main", SyntheticMonitoringProbeArgs.builder()        
            .labels(Map.of("type", "mountain"))
            .latitude(27.98606)
            .longitude(86.92262)
            .region("APAC")
            .build());

    }
}

import pulumi
import lbrlabs_pulumi_grafana as grafana

main = grafana.SyntheticMonitoringProbe("main",
    labels={
        "type": "mountain",
    },
    latitude=27.98606,
    longitude=86.92262,
    region="APAC")

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@lbrlabs/pulumi-grafana";

const main = new grafana.SyntheticMonitoringProbe("main", {
    labels: {
        type: "mountain",
    },
    latitude: 27.98606,
    longitude: 86.92262,
    region: "APAC",
});

resources:
  main:
    type: grafana:SyntheticMonitoringProbe
    properties:
      labels:
        type: mountain
      latitude: 27.98606
      longitude: 86.92262
      region: APAC

Create SyntheticMonitoringProbe Resource

new SyntheticMonitoringProbe(name: string, args: SyntheticMonitoringProbeArgs, opts?: CustomResourceOptions);
@overload
def SyntheticMonitoringProbe(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             labels: Optional[Mapping[str, str]] = None,
                             latitude: Optional[float] = None,
                             longitude: Optional[float] = None,
                             name: Optional[str] = None,
                             public: Optional[bool] = None,
                             region: Optional[str] = None)
@overload
def SyntheticMonitoringProbe(resource_name: str,
                             args: SyntheticMonitoringProbeArgs,
                             opts: Optional[ResourceOptions] = None)
func NewSyntheticMonitoringProbe(ctx *Context, name string, args SyntheticMonitoringProbeArgs, opts ...ResourceOption) (*SyntheticMonitoringProbe, error)
public SyntheticMonitoringProbe(string name, SyntheticMonitoringProbeArgs args, CustomResourceOptions? opts = null)
public SyntheticMonitoringProbe(String name, SyntheticMonitoringProbeArgs args)
public SyntheticMonitoringProbe(String name, SyntheticMonitoringProbeArgs args, CustomResourceOptions options)

type: grafana:SyntheticMonitoringProbe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SyntheticMonitoringProbeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args SyntheticMonitoringProbeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args SyntheticMonitoringProbeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SyntheticMonitoringProbeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SyntheticMonitoringProbeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SyntheticMonitoringProbe Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The SyntheticMonitoringProbe resource accepts the following input properties:

Latitude double

Latitude coordinates.

Longitude double

Longitude coordinates.

Region string

Region of the probe.

Labels Dictionary<string, string>

Custom labels to be included with collected metrics and logs.

Name string

Name of the probe.

Public bool

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

Latitude float64

Latitude coordinates.

Longitude float64

Longitude coordinates.

Region string

Region of the probe.

Labels map[string]string

Custom labels to be included with collected metrics and logs.

Name string

Name of the probe.

Public bool

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

latitude Double

Latitude coordinates.

longitude Double

Longitude coordinates.

region String

Region of the probe.

labels Map<String,String>

Custom labels to be included with collected metrics and logs.

name String

Name of the probe.

public_ Boolean

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

latitude number

Latitude coordinates.

longitude number

Longitude coordinates.

region string

Region of the probe.

labels {[key: string]: string}

Custom labels to be included with collected metrics and logs.

name string

Name of the probe.

public boolean

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

latitude float

Latitude coordinates.

longitude float

Longitude coordinates.

region str

Region of the probe.

labels Mapping[str, str]

Custom labels to be included with collected metrics and logs.

name str

Name of the probe.

public bool

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

latitude Number

Latitude coordinates.

longitude Number

Longitude coordinates.

region String

Region of the probe.

labels Map<String>

Custom labels to be included with collected metrics and logs.

name String

Name of the probe.

public Boolean

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the SyntheticMonitoringProbe resource produces the following output properties:

AuthToken string

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

Id string

The provider-assigned unique ID for this managed resource.

TenantId int

The tenant ID of the probe.

AuthToken string

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

Id string

The provider-assigned unique ID for this managed resource.

TenantId int

The tenant ID of the probe.

authToken String

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

id String

The provider-assigned unique ID for this managed resource.

tenantId Integer

The tenant ID of the probe.

authToken string

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

id string

The provider-assigned unique ID for this managed resource.

tenantId number

The tenant ID of the probe.

auth_token str

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

id str

The provider-assigned unique ID for this managed resource.

tenant_id int

The tenant ID of the probe.

authToken String

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

id String

The provider-assigned unique ID for this managed resource.

tenantId Number

The tenant ID of the probe.

Look up Existing SyntheticMonitoringProbe Resource

Get an existing SyntheticMonitoringProbe resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SyntheticMonitoringProbeState, opts?: CustomResourceOptions): SyntheticMonitoringProbe
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_token: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        latitude: Optional[float] = None,
        longitude: Optional[float] = None,
        name: Optional[str] = None,
        public: Optional[bool] = None,
        region: Optional[str] = None,
        tenant_id: Optional[int] = None) -> SyntheticMonitoringProbe
func GetSyntheticMonitoringProbe(ctx *Context, name string, id IDInput, state *SyntheticMonitoringProbeState, opts ...ResourceOption) (*SyntheticMonitoringProbe, error)
public static SyntheticMonitoringProbe Get(string name, Input<string> id, SyntheticMonitoringProbeState? state, CustomResourceOptions? opts = null)
public static SyntheticMonitoringProbe get(String name, Output<String> id, SyntheticMonitoringProbeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AuthToken string

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

Labels Dictionary<string, string>

Custom labels to be included with collected metrics and logs.

Latitude double

Latitude coordinates.

Longitude double

Longitude coordinates.

Name string

Name of the probe.

Public bool

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

Region string

Region of the probe.

TenantId int

The tenant ID of the probe.

AuthToken string

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

Labels map[string]string

Custom labels to be included with collected metrics and logs.

Latitude float64

Latitude coordinates.

Longitude float64

Longitude coordinates.

Name string

Name of the probe.

Public bool

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

Region string

Region of the probe.

TenantId int

The tenant ID of the probe.

authToken String

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

labels Map<String,String>

Custom labels to be included with collected metrics and logs.

latitude Double

Latitude coordinates.

longitude Double

Longitude coordinates.

name String

Name of the probe.

public_ Boolean

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

region String

Region of the probe.

tenantId Integer

The tenant ID of the probe.

authToken string

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

labels {[key: string]: string}

Custom labels to be included with collected metrics and logs.

latitude number

Latitude coordinates.

longitude number

Longitude coordinates.

name string

Name of the probe.

public boolean

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

region string

Region of the probe.

tenantId number

The tenant ID of the probe.

auth_token str

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

labels Mapping[str, str]

Custom labels to be included with collected metrics and logs.

latitude float

Latitude coordinates.

longitude float

Longitude coordinates.

name str

Name of the probe.

public bool

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

region str

Region of the probe.

tenant_id int

The tenant ID of the probe.

authToken String

The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.

labels Map<String>

Custom labels to be included with collected metrics and logs.

latitude Number

Latitude coordinates.

longitude Number

Longitude coordinates.

name String

Name of the probe.

public Boolean

Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

region String

Region of the probe.

tenantId Number

The tenant ID of the probe.

Import

 $ pulumi import grafana:index/syntheticMonitoringProbe:SyntheticMonitoringProbe probe {{probe-id}}

 $ pulumi import grafana:index/syntheticMonitoringProbe:SyntheticMonitoringProbe probe {{probe-id}}:{{auth_token}}

Package Details

Repository
grafana lbrlabs/pulumi-grafana
License
Apache-2.0
Notes

This Pulumi package is based on the grafana Terraform Provider.