Class: Fastly::LoggingGrafanacloudlogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/logging_grafanacloudlogs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingGrafanacloudlogsApi

Returns a new instance of LoggingGrafanacloudlogsApi.



17
18
19
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_log_grafanacloudlogs(opts = {}) ⇒ LoggingGrafanacloudlogsResponse

Create a Grafana Cloud Logs log endpoint Create a Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (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`.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).

  • :log_processing_region (String) —

    The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (default to ‘none’)

  • :format_version (Integer) —

    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`. (default to FORMAT_VERSION::v2)

  • :user (String) —

    The Grafana Cloud Logs Dataset you want to log to.

  • :url (String) —

    The URL of the Loki instance in your Grafana stack.

  • :token (String) —

    The Grafana Access Policy token with `logs:write` access scoped to your Loki instance.

  • :index (String) —

    The Stream Labels, a JSON string used to identify the stream.

Returns:



35
36
37
38
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 35

def create_log_grafanacloudlogs(opts = {})
  data, _status_code, _headers = create_log_grafanacloudlogs_with_http_info(opts)
  data
end

#create_log_grafanacloudlogs_with_http_info(opts = {}) ⇒ Array<(LoggingGrafanacloudlogsResponse, Integer, Hash)>

Create a Grafana Cloud Logs log endpoint Create a Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).

  • :log_processing_region (String) —

    The geographic region where the logs will be processed before streaming. Valid values are &#x60;us&#x60;, &#x60;eu&#x60;, and &#x60;none&#x60; for global. (default to ‘none’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :user (String) —

    The Grafana Cloud Logs Dataset you want to log to.

  • :url (String) —

    The URL of the Loki instance in your Grafana stack.

  • :token (String) —

    The Grafana Access Policy token with &#x60;logs:write&#x60; access scoped to your Loki instance.

  • :index (String) —

    The Stream Labels, a JSON string used to identify the stream.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 55

def create_log_grafanacloudlogs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingGrafanacloudlogsApi.create_log_grafanacloudlogs ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingGrafanacloudlogsApi.create_log_grafanacloudlogs"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingGrafanacloudlogsApi.create_log_grafanacloudlogs"
  end
  allowable_values = ["none", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = ["none", "eu", "us"]
  if @api_client.config.client_side_validation && opts[:'log_processing_region'] && !allowable_values.include?(opts[:'log_processing_region'])
    fail ArgumentError, "invalid value for \"log_processing_region\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/grafanacloudlogs'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['log_processing_region'] = opts[:'log_processing_region'] if !opts[:'log_processing_region'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['user'] = opts[:'user'] if !opts[:'user'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
  form_params['index'] = opts[:'index'] if !opts[:'index'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingGrafanacloudlogsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingGrafanacloudlogsApi.create_log_grafanacloudlogs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingGrafanacloudlogsApi#create_log_grafanacloudlogs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_log_grafanacloudlogs(opts = {}) ⇒ InlineResponse200

Delete the Grafana Cloud Logs log endpoint Delete the Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_grafanacloudlogs_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



143
144
145
146
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 143

def delete_log_grafanacloudlogs(opts = {})
  data, _status_code, _headers = delete_log_grafanacloudlogs_with_http_info(opts)
  data
end

#delete_log_grafanacloudlogs_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete the Grafana Cloud Logs log endpoint Delete the Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_grafanacloudlogs_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 154

def delete_log_grafanacloudlogs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingGrafanacloudlogsApi.delete_log_grafanacloudlogs ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_grafanacloudlogs_name = opts[:'logging_grafanacloudlogs_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingGrafanacloudlogsApi.delete_log_grafanacloudlogs"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingGrafanacloudlogsApi.delete_log_grafanacloudlogs"
  end
  # verify the required parameter 'logging_grafanacloudlogs_name' is set
  if @api_client.config.client_side_validation && logging_grafanacloudlogs_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_grafanacloudlogs_name' when calling LoggingGrafanacloudlogsApi.delete_log_grafanacloudlogs"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/grafanacloudlogs/{logging_grafanacloudlogs_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_grafanacloudlogs_name' + '}', CGI.escape(logging_grafanacloudlogs_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingGrafanacloudlogsApi.delete_log_grafanacloudlogs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingGrafanacloudlogsApi#delete_log_grafanacloudlogs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_log_grafanacloudlogs(opts = {}) ⇒ LoggingGrafanacloudlogsResponse

Get a Grafana Cloud Logs log endpoint Get the details of a Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_grafanacloudlogs_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



220
221
222
223
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 220

def get_log_grafanacloudlogs(opts = {})
  data, _status_code, _headers = get_log_grafanacloudlogs_with_http_info(opts)
  data
end

#get_log_grafanacloudlogs_with_http_info(opts = {}) ⇒ Array<(LoggingGrafanacloudlogsResponse, Integer, Hash)>

Get a Grafana Cloud Logs log endpoint Get the details of a Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_grafanacloudlogs_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 231

def get_log_grafanacloudlogs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingGrafanacloudlogsApi.get_log_grafanacloudlogs ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_grafanacloudlogs_name = opts[:'logging_grafanacloudlogs_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingGrafanacloudlogsApi.get_log_grafanacloudlogs"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingGrafanacloudlogsApi.get_log_grafanacloudlogs"
  end
  # verify the required parameter 'logging_grafanacloudlogs_name' is set
  if @api_client.config.client_side_validation && logging_grafanacloudlogs_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_grafanacloudlogs_name' when calling LoggingGrafanacloudlogsApi.get_log_grafanacloudlogs"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/grafanacloudlogs/{logging_grafanacloudlogs_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_grafanacloudlogs_name' + '}', CGI.escape(logging_grafanacloudlogs_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingGrafanacloudlogsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingGrafanacloudlogsApi.get_log_grafanacloudlogs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingGrafanacloudlogsApi#get_log_grafanacloudlogs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_log_grafanacloudlogs(opts = {}) ⇒ Array<LoggingGrafanacloudlogsResponse>

List Grafana Cloud Logs log endpoints List all of the Grafana Cloud Logs logging objects for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



296
297
298
299
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 296

def list_log_grafanacloudlogs(opts = {})
  data, _status_code, _headers = list_log_grafanacloudlogs_with_http_info(opts)
  data
end

#list_log_grafanacloudlogs_with_http_info(opts = {}) ⇒ Array<(Array<LoggingGrafanacloudlogsResponse>, Integer, Hash)>

List Grafana Cloud Logs log endpoints List all of the Grafana Cloud Logs logging objects for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Array<LoggingGrafanacloudlogsResponse>, Integer, Hash)>) —

    Array<LoggingGrafanacloudlogsResponse> data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 306

def list_log_grafanacloudlogs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingGrafanacloudlogsApi.list_log_grafanacloudlogs ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingGrafanacloudlogsApi.list_log_grafanacloudlogs"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingGrafanacloudlogsApi.list_log_grafanacloudlogs"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/grafanacloudlogs'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LoggingGrafanacloudlogsResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingGrafanacloudlogsApi.list_log_grafanacloudlogs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingGrafanacloudlogsApi#list_log_grafanacloudlogs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_log_grafanacloudlogs(opts = {}) ⇒ LoggingGrafanacloudlogsResponse

Update a Grafana Cloud Logs log endpoint Update a Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_grafanacloudlogs_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).

  • :log_processing_region (String) —

    The geographic region where the logs will be processed before streaming. Valid values are &#x60;us&#x60;, &#x60;eu&#x60;, and &#x60;none&#x60; for global. (default to ‘none’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :user (String) —

    The Grafana Cloud Logs Dataset you want to log to.

  • :url (String) —

    The URL of the Loki instance in your Grafana stack.

  • :token (String) —

    The Grafana Access Policy token with &#x60;logs:write&#x60; access scoped to your Loki instance.

  • :index (String) —

    The Stream Labels, a JSON string used to identify the stream.

Returns:



377
378
379
380
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 377

def update_log_grafanacloudlogs(opts = {})
  data, _status_code, _headers = update_log_grafanacloudlogs_with_http_info(opts)
  data
end

#update_log_grafanacloudlogs_with_http_info(opts = {}) ⇒ Array<(LoggingGrafanacloudlogsResponse, Integer, Hash)>

Update a Grafana Cloud Logs log endpoint Update a Grafana Cloud Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_grafanacloudlogs_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).

  • :log_processing_region (String) —

    The geographic region where the logs will be processed before streaming. Valid values are &#x60;us&#x60;, &#x60;eu&#x60;, and &#x60;none&#x60; for global. (default to ‘none’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :user (String) —

    The Grafana Cloud Logs Dataset you want to log to.

  • :url (String) —

    The URL of the Loki instance in your Grafana stack.

  • :token (String) —

    The Grafana Access Policy token with &#x60;logs:write&#x60; access scoped to your Loki instance.

  • :index (String) —

    The Stream Labels, a JSON string used to identify the stream.

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/fastly/api/logging_grafanacloudlogs_api.rb', line 398

def update_log_grafanacloudlogs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingGrafanacloudlogsApi.update_log_grafanacloudlogs ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_grafanacloudlogs_name = opts[:'logging_grafanacloudlogs_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingGrafanacloudlogsApi.update_log_grafanacloudlogs"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingGrafanacloudlogsApi.update_log_grafanacloudlogs"
  end
  # verify the required parameter 'logging_grafanacloudlogs_name' is set
  if @api_client.config.client_side_validation && logging_grafanacloudlogs_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_grafanacloudlogs_name' when calling LoggingGrafanacloudlogsApi.update_log_grafanacloudlogs"
  end
  allowable_values = ["none", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = ["none", "eu", "us"]
  if @api_client.config.client_side_validation && opts[:'log_processing_region'] && !allowable_values.include?(opts[:'log_processing_region'])
    fail ArgumentError, "invalid value for \"log_processing_region\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/grafanacloudlogs/{logging_grafanacloudlogs_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_grafanacloudlogs_name' + '}', CGI.escape(logging_grafanacloudlogs_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['log_processing_region'] = opts[:'log_processing_region'] if !opts[:'log_processing_region'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['user'] = opts[:'user'] if !opts[:'user'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
  form_params['index'] = opts[:'index'] if !opts[:'index'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingGrafanacloudlogsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingGrafanacloudlogsApi.update_log_grafanacloudlogs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingGrafanacloudlogsApi#update_log_grafanacloudlogs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end