Get Container Logs Deployed On Node

  • Article

Gets the container logs for container deployed on a Service Fabric node.

Gets the container logs for container deployed on a Service Fabric node for the given code package.

Request

Method Request URI
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs?api-version=6.2&ServiceManifestName={ServiceManifestName}&CodePackageName={CodePackageName}&Tail={Tail}&Previous={Previous}&timeout={timeout}

Parameters

Name Type Required Location
nodeName string Yes Path
applicationId string Yes Path
api-version string Yes Query
ServiceManifestName string Yes Query
CodePackageName string Yes Query
Tail string No Query
Previous boolean No Query
timeout integer (int64) No Query

nodeName

Type: string
Required: Yes

The name of the node.

applicationId

Type: string
Required: Yes

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

api-version

Type: string
Required: Yes
Default: 6.2

The version of the API. This parameter is required and its value must be '6.2'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

ServiceManifestName

Type: string
Required: Yes

The name of a service manifest registered as part of an application type in a Service Fabric cluster.

CodePackageName

Type: string
Required: Yes

The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.

Tail

Type: string
Required: No

Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs.

Previous

Type: boolean
Required: No
Default: false

Specifies whether to get container logs from exited/dead containers of the code package instance.

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.
 ContainerLogs
All other status codes The detailed error response.
 FabricError

Examples

Get container logs for given code package

This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.

Request

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/SimpleHttpServerApp/$/GetCodePackages/$/ContainerLogs?api-version=6.2&ServiceManifestName=SimpleHttpServerSvcPkg&CodePackageName=Code

200 Response

Body
{
  "Content": "HTTP Server started listening on port 8080\r\n"
}

Get last 10 lines of container logs

This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.

Request

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/SimpleHttpServerApp/$/GetCodePackages/$/ContainerLogs?api-version=6.2&ServiceManifestName=SimpleHttpServerSvcPkg&CodePackageName=Code&Tail=10

200 Response

Body
{
  "Content": "UTC Time Now: 04/02/2018 22:06:31\r\nUTC Time Now: 04/02/2018 22:06:32\r\nUTC Time Now: 04/02/2018 22:06:33\r\nUTC Time Now: 04/02/2018 22:06:344\r\nUTC Time Now: 04/02/2018 22:06:35\r\nUTC Time Now: 04/02/2018 22:06:36\r\nUTC Time Now: 04/02/2018 22:06:37\r\nUTC Time Now: 04/02/2018 22:06:38\r\nUTC Time Now: 04/02/2018 22:06:39\r\nUTC Time Now: 04/02/2018 22:06:40\r\n"
}

Get container logs of previous dead container for given code package

This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.

Request

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/SimpleHttpServerApp/$/GetCodePackages/$/ContainerLogs?api-version=6.2&ServiceManifestName=SimpleHttpServerSvcPkg&CodePackageName=Code&Previous=True

200 Response

Body
{
  "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n"
}