LoggingScalyrAPI

Note

All URIs are relative to https://api.fastly.com

Method	HTTP request	Description
CreateLogScalyr	POST `/service/{service_id}/version/{version_id}/logging/scalyr`	Create a Scalyr log endpoint
DeleteLogScalyr	DELETE `/service/{service_id}/version/{version_id}/logging/scalyr/{logging_scalyr_name}`	Delete the Scalyr log endpoint
GetLogScalyr	GET `/service/{service_id}/version/{version_id}/logging/scalyr/{logging_scalyr_name}`	Get a Scalyr log endpoint
ListLogScalyr	GET `/service/{service_id}/version/{version_id}/logging/scalyr`	List Scalyr log endpoints
UpdateLogScalyr	PUT `/service/{service_id}/version/{version_id}/logging/scalyr/{logging_scalyr_name}`	Update the Scalyr log endpoint

CreateLogScalyr

Create a Scalyr log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    name := "name_example" // string | The name for the real-time logging configuration. (optional)
    placement := "placement_example" // string | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.  (optional)
    responseCondition := "responseCondition_example" // string | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format := "format_example" // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) (default to "%h %l %u %t \"%r\" %&gt;s %b")
    formatVersion := int32(56) // int32 | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.  (optional) (default to 2)
    region := "region_example" // string | The region that log data will be sent to. (optional) (default to "US")
    token := "token_example" // string | The token to use for authentication. (optional)
    projectID := "projectId_example" // string | The name of the logfile within Scalyr. (optional) (default to "logplex")

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingScalyrAPI.CreateLogScalyr(ctx, serviceID, versionID).Name(name).Placement(placement).ResponseCondition(responseCondition).Format(format).FormatVersion(formatVersion).Region(region).Token(token).ProjectID(projectID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingScalyrAPI.CreateLogScalyr`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLogScalyr`: LoggingScalyrResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingScalyrAPI.CreateLogScalyr`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.

Other Parameters

Other parameters are passed through a pointer to a apiCreateLogScalyrRequest struct via the builder pattern

Name	Type	Description	Notes
name	string	The name for the real-time logging configuration.	placement

Return type

LoggingScalyrResponse

Authorization

API Token

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

Back to top | Back to API list | Back to README

DeleteLogScalyr

Delete the Scalyr log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingScalyrName := "loggingScalyrName_example" // string | The name for the real-time logging configuration.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingScalyrAPI.DeleteLogScalyr(ctx, serviceID, versionID, loggingScalyrName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingScalyrAPI.DeleteLogScalyr`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLogScalyr`: InlineResponse200
    fmt.Fprintf(os.Stdout, "Response from `LoggingScalyrAPI.DeleteLogScalyr`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingScalyrName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLogScalyrRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

InlineResponse200

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

GetLogScalyr

Get a Scalyr log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingScalyrName := "loggingScalyrName_example" // string | The name for the real-time logging configuration.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingScalyrAPI.GetLogScalyr(ctx, serviceID, versionID, loggingScalyrName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingScalyrAPI.GetLogScalyr`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogScalyr`: LoggingScalyrResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingScalyrAPI.GetLogScalyr`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingScalyrName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiGetLogScalyrRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

LoggingScalyrResponse

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

ListLogScalyr

List Scalyr log endpoints

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingScalyrAPI.ListLogScalyr(ctx, serviceID, versionID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingScalyrAPI.ListLogScalyr`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListLogScalyr`: []LoggingScalyrResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingScalyrAPI.ListLogScalyr`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.

Other Parameters

Other parameters are passed through a pointer to a apiListLogScalyrRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]LoggingScalyrResponse

Authorization

API Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

Back to top | Back to API list | Back to README

UpdateLogScalyr

Update the Scalyr log endpoint

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    serviceID := "serviceId_example" // string | Alphanumeric string identifying the service.
    versionID := int32(56) // int32 | Integer identifying a service version.
    loggingScalyrName := "loggingScalyrName_example" // string | The name for the real-time logging configuration.
    name := "name_example" // string | The name for the real-time logging configuration. (optional)
    placement := "placement_example" // string | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.  (optional)
    responseCondition := "responseCondition_example" // string | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format := "format_example" // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) (default to "%h %l %u %t \"%r\" %&gt;s %b")
    formatVersion := int32(56) // int32 | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.  (optional) (default to 2)
    region := "region_example" // string | The region that log data will be sent to. (optional) (default to "US")
    token := "token_example" // string | The token to use for authentication. (optional)
    projectID := "projectId_example" // string | The name of the logfile within Scalyr. (optional) (default to "logplex")

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.LoggingScalyrAPI.UpdateLogScalyr(ctx, serviceID, versionID, loggingScalyrName).Name(name).Placement(placement).ResponseCondition(responseCondition).Format(format).FormatVersion(formatVersion).Region(region).Token(token).ProjectID(projectID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoggingScalyrAPI.UpdateLogScalyr`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateLogScalyr`: LoggingScalyrResponse
    fmt.Fprintf(os.Stdout, "Response from `LoggingScalyrAPI.UpdateLogScalyr`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceID	string	Alphanumeric string identifying the service.
versionID	int32	Integer identifying a service version.
loggingScalyrName	string	The name for the real-time logging configuration.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateLogScalyrRequest struct via the builder pattern

Name	Type	Description	Notes
name	string	The name for the real-time logging configuration.	placement

Return type

LoggingScalyrResponse

Authorization

API Token

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

Back to top | Back to API list | Back to README

Files

LoggingScalyrAPI.md

Latest commit

History

LoggingScalyrAPI.md

File metadata and controls

LoggingScalyrAPI

CreateLogScalyr

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteLogScalyr

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLogScalyr

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListLogScalyr

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateLogScalyr

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers