Method CaptureLogs

pkg/ddevapp/ddevapp.go:2723–2771

CaptureLogs returns logs for a site's given container. See docker.LogsOptions for more information about valid tailLines values.

(service string, timestamps bool, tailLines string)

// CaptureLogs returns logs for a site's given container.
// See docker.LogsOptions for more information about valid tailLines values.
func (app *DdevApp) CaptureLogs(service string, timestamps bool, tailLines string) (string, error) {
	ctx, apiClient, err := dockerutil.GetDockerClient()
	if err != nil {
		return "", err
	}

	var c *container.Summary
	// Let people access ddev-router and ddev-ssh-agent logs as well.
	if service == "ddev-router" || service == "ddev-ssh-agent" {
		c, err = dockerutil.FindContainerByLabels(map[string]string{
			"com.docker.compose.service": service,
			"com.docker.compose.oneoff":  "False",
		})
	} else {
		c, err = app.FindContainerByType(service)
	}
	if err != nil {
		return "", err
	}
	if c == nil {
		util.Warning("No running service container %s was found", service)
		return "", nil
	}

	var stdout bytes.Buffer
	logOpts := client.ContainerLogsOptions{
		ShowStdout: true,
		ShowStderr: true,
		Follow:     false,
		Timestamps: timestamps,
	}

	if tailLines != "" {
		logOpts.Tail = tailLines
	}

	rc, err := apiClient.ContainerLogs(ctx, c.ID, logOpts)
	if err != nil {
		return "", err
	}
	defer rc.Close()

	_, err = stdcopy.StdCopy(&stdout, &stdout, rc)
	if err != nil {
		return "", fmt.Errorf("failed to copy container logs: %v", err)
	}

	return stdout.String(), nil
}

// DockerEnv sets environment variables for a docker-compose run.
func (app *DdevApp) DockerEnv() map[string]string {